public interface DocetSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ActivityUnitSearchOrder |
getActivityUnitSearchOrder()
Gets the search order for an actvity unit.
|
DocetSearchOrderRecord |
getDocetSearchOrderRecord(Type docetRecordType)
Gets the docet search order record corresponding to the given docet
record Type.
|
ModuleSearchOrder |
getModuleSearchOrder()
Gets the search order for a module.
|
void |
orderByActivityUnit(SearchOrderStyle style)
Specified a preference for ordering results by the activity unit.
|
void |
orderByDuration(SearchOrderStyle style)
Specified a preference for ordering results by the duration.
|
void |
orderByInClass(SearchOrderStyle style)
Specified a preference for ordering results by the in class flag.
|
void |
orderByModule(SearchOrderStyle style)
Specified a preference for ordering results by the module.
|
boolean |
supportsActivityUnitSearchOrder()
Tests if an
ActivityUnitSearchOrder is available. |
boolean |
supportsModuleSearchOrder()
Tests if a
ModuleSearchOrder is available. |
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByModule(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsModuleSearchOrder()
ModuleSearchOrder
is available. true
if a module search order is available,
false
otherwisemandatory
- This method must be implemented. ModuleSearchOrder getModuleSearchOrder()
UnimplementedException
-
supportsModuleSearchOrder()
is false
optional
- This method must be implemented if
supportsModuleSearchOrder()
is true.
void orderByActivityUnit(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsActivityUnitSearchOrder()
ActivityUnitSearchOrder
is available. true
if an activity unit search order is
available, false
otherwisemandatory
- This method must be implemented. ActivityUnitSearchOrder getActivityUnitSearchOrder()
UnimplementedException
-
supportsActivityUnitSearchOrder()
is false
optional
- This method must be implemented if
supportsActivityUnitSearchOrder()
is true.
void orderByInClass(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDuration(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. DocetSearchOrderRecord getDocetSearchOrderRecord(Type docetRecordType) throws OperationFailedException
docetRecordType
- a docet record typeNullArgumentException
- docetRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(docetRecordType)
is false
mandatory
- This method must be implemented.