Interface | osid.learning.ActivitySearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByObjective | ||
Description |
Specifies a preference for ordering the result set by the objective. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsObjectiveSearchOrder | ||
Description |
Tests if an objective search order is available. | ||
Return | boolean | true if an objective search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveSearchOrder | ||
Description |
Gets an objective search order. | ||
Return | osid.learning.ObjectiveSearchOrder | an objective search order | |
Errors | UNIMPLEMENTED | supportsObjectiveSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsObjectiveSearchOrder()
is true. | |
Method | getActivitySearchOrderRecord | ||
Description |
Gets the activity search order record corresponding to
the given activity record | ||
Parameters | osid.type.Type | activityRecordType | an activity record type |
Return | osid.learning.records.ActivitySearchOrderRecord | the activity search order record | |
Errors | NULL_ARGUMENT | activityRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(activityRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |