public interface ActivitySearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ActivitySearchOrderRecord |
getActivitySearchOrderRecord(Type activityRecordType)
Gets the activity search order record corresponding to the given
activity record
Type. |
ObjectiveSearchOrder |
getObjectiveSearchOrder()
Gets an objective search order.
|
void |
orderByObjective(SearchOrderStyle style)
Specifies a preference for ordering the result set by the objective.
|
boolean |
supportsObjectiveSearchOrder()
Tests if an objective search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByObjective(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsObjectiveSearchOrder()
true
if an objective search order is available,
false
otherwisemandatory
- This method must be implemented. ObjectiveSearchOrder getObjectiveSearchOrder()
UnimplementedException
-
supportsObjectiveSearchOrder()
is false
optional
- This method must be implemented if
supportsObjectiveSearchOrder()
is true.
ActivitySearchOrderRecord getActivitySearchOrderRecord(Type activityRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.activityRecordType
- an activity record typeNullArgumentException
- activityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityRecordType)
is false
mandatory
- This method must be implemented.