org.osid.course.chronicle

Interface AwardEntrySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface AwardEntrySearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentSearchOrder	getAssessmentSearchOrder() Gets the assessment order.
AwardEntrySearchOrderRecord	getAwardEntrySearchOrderRecord(Type awardEntryRecordType) Gets the award search order record corresponding to the given award entry record Type.
AwardSearchOrder	getAwardSearchOrder() Gets the award order.
CourseSearchOrder	getCourseSearchOrder() Gets the course order.
ProgramSearchOrder	getProgramSearchOrder() Gets the program order.
ResourceSearchOrder	getStudentSearchOrder() Gets the resource order.
void	orderByAssessment(SearchOrderStyle style) Specifies a preference for ordering the result set by the assessment.
void	orderByAward(SearchOrderStyle style) Specifies a preference for ordering the result set by the award.
void	orderByCourse(SearchOrderStyle style) Specifies a preference for ordering the result set by the course.
void	orderByDateAwarded(SearchOrderStyle style) Specifies a preference for ordering the result set by the award date.
void	orderByProgram(SearchOrderStyle style) Specifies a preference for ordering the result set by the program.
void	orderByStudent(SearchOrderStyle style) Specifies a preference for ordering the result set by the resource.
boolean	supportsAssessmentSearchOrder() Tests if an assessment order is available.
boolean	supportsAwardSearchOrder() Tests if an award order is available.
boolean	supportsCourseSearchOrder() Tests if a course order is available.
boolean	supportsProgramSearchOrder() Tests if a program order is available.
boolean	supportsStudentSearchOrder() Tests if a resource order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByStudent

void orderByStudent(SearchOrderStyle style)

Specifies a preference for ordering the result set by the resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsStudentSearchOrder

boolean supportsStudentSearchOrder()

Tests if a resource order is available.

Returns:

true if a resource order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStudentSearchOrder

ResourceSearchOrder getStudentSearchOrder()

Gets the resource order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsStudentSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsStudentSearchOrder() is true.

orderByAward

void orderByAward(SearchOrderStyle style)

Specifies a preference for ordering the result set by the award.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAwardSearchOrder

boolean supportsAwardSearchOrder()

Tests if an award order is available.

Returns:

true if an award order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAwardSearchOrder

AwardSearchOrder getAwardSearchOrder()

Gets the award order.

Returns:

the award search order

Throws:

UnimplementedException - supportsAwardSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsAwardSearchOrder() is true.

orderByDateAwarded

void orderByDateAwarded(SearchOrderStyle style)

Specifies a preference for ordering the result set by the award date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByProgram

void orderByProgram(SearchOrderStyle style)

Specifies a preference for ordering the result set by the program.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProgramSearchOrder

boolean supportsProgramSearchOrder()

Tests if a program order is available.

Returns:

true if a program order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProgramSearchOrder

ProgramSearchOrder getProgramSearchOrder()

Gets the program order.

Returns:

the program search order

Throws:

UnimplementedException - supportsProgramSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsProgramSearchOrder() is true.

orderByCourse

void orderByCourse(SearchOrderStyle style)

Specifies a preference for ordering the result set by the course.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCourseSearchOrder

boolean supportsCourseSearchOrder()

Tests if a course order is available.

Returns:

true if a course order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseSearchOrder

CourseSearchOrder getCourseSearchOrder()

Gets the course order.

Returns:

the course search order

Throws:

UnimplementedException - supportsCourseSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsCourseSearchOrder() is true.

orderByAssessment

void orderByAssessment(SearchOrderStyle style)

Specifies a preference for ordering the result set by the assessment.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAssessmentSearchOrder

boolean supportsAssessmentSearchOrder()

Tests if an assessment order is available.

Returns:

true if an assessment order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssessmentSearchOrder

AssessmentSearchOrder getAssessmentSearchOrder()

Gets the assessment order.

Returns:

the assessment search order

Throws:

UnimplementedException - supportsAssessmentSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsAssessmentSearchOrder() is true.

getAwardEntrySearchOrderRecord

AwardEntrySearchOrderRecord getAwardEntrySearchOrderRecord(Type awardEntryRecordType)
                                                           throws OperationFailedException

Gets the award search order record corresponding to the given award entry record Type. Multiple retrievals return the same underlying object.

Parameters:

awardEntryRecordType - an award entry record type

Returns:

the award entry search order record

Throws:

NullArgumentException - awardEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.