public interface AwardEntrySearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
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.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByStudent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsStudentSearchOrder()
true
if a resource order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getStudentSearchOrder()
UnimplementedException
-
supportsStudentSearchOrder()
is false
optional
- This method must be implemented if
supportsStudentSearchOrder()
is true.
void orderByAward(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAwardSearchOrder()
true
if an award order is available,
false
otherwisemandatory
- This method must be implemented. AwardSearchOrder getAwardSearchOrder()
UnimplementedException
-
supportsAwardSearchOrder()
is false
optional
- This method must be implemented if
supportsAwardSearchOrder()
is true.
void orderByDateAwarded(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByProgram(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsProgramSearchOrder()
true
if a program order is available,
false
otherwisemandatory
- This method must be implemented. ProgramSearchOrder getProgramSearchOrder()
UnimplementedException
-
supportsProgramSearchOrder()
is false
optional
- This method must be implemented if
supportsProgramSearchOrder()
is true.
void orderByCourse(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCourseSearchOrder()
true
if a course order is available,
false
otherwisemandatory
- This method must be implemented. CourseSearchOrder getCourseSearchOrder()
UnimplementedException
-
supportsCourseSearchOrder()
is false
optional
- This method must be implemented if
supportsCourseSearchOrder()
is true.
void orderByAssessment(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAssessmentSearchOrder()
true
if an assessment order is available,
false
otherwisemandatory
- This method must be implemented. AssessmentSearchOrder getAssessmentSearchOrder()
UnimplementedException
-
supportsAssessmentSearchOrder()
is false
optional
- This method must be implemented if
supportsAssessmentSearchOrder()
is true.
AwardEntrySearchOrderRecord getAwardEntrySearchOrderRecord(Type awardEntryRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.awardEntryRecordType
- an award entry record typeNullArgumentException
- awardEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(awardEntryRecordType)
is false
mandatory
- This method must be implemented.