public interface SyllabusSearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CourseSearchOrder |
getCourseSearchOrder()
Gets the course order.
|
SyllabusSearchOrderRecord |
getSyllabusSearchOrderRecord(Type syllabusRecordType)
Gets the syllabus search order record corresponding to the given
syllabus record
Type. |
void |
orderByCourse(SearchOrderStyle style)
Specifies a preference for ordering the result set by the course.
|
boolean |
supportsCourseSearchOrder()
Tests if a course order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
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.
SyllabusSearchOrderRecord getSyllabusSearchOrderRecord(Type syllabusRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.syllabusRecordType
- a syllabus record typeNullArgumentException
- syllabusRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(syllabusRecordType)
is false
mandatory
- This method must be implemented.