public interface ModuleSearchOrder extends OsidGovernatorSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ModuleSearchOrderRecord |
getModuleSearchOrderRecord(Type moduleRecordType)
Gets the module search order record corresponding to the given module
record
Type. |
SyllabusSearchOrder |
getSyllabusSearchOrder()
Gets the syllabus order.
|
void |
orderBySyllabus(SearchOrderStyle style)
Specifies a preference for ordering the result set by the syllabus.
|
boolean |
supportsSyllabusSearchOrder()
Tests if a syllabus order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder
void orderBySyllabus(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSyllabusSearchOrder()
true
if a syllabus order is available,
false
otherwisemandatory
- This method must be implemented. SyllabusSearchOrder getSyllabusSearchOrder()
UnimplementedException
-
supportsSyllabusSearchOrder()
is false
optional
- This method must be implemented if
supportsCourseSearchOrder()
is true.
ModuleSearchOrderRecord getModuleSearchOrderRecord(Type moduleRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.moduleRecordType
- a module record typeNullArgumentException
- moduleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(moduleRecordType)
is false
mandatory
- This method must be implemented.