| Interface | osid.assessment.ItemSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidAggregateableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByQuestion | ||
| Description |
Specifies a preference for ordering the result set by the question. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsQuestionSearchOrder | ||
| Description |
Tests if a question search order is available. | ||
| Return | boolean | true if a question search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQuestionSearchOrder | ||
| Description |
Gets a question search order. | ||
| Return | osid.assessment.QuestionSearchOrder | a question search order | |
| Errors | UNIMPLEMENTED | supportsQuestionSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsQuestionSearchOrder()
is true. | |
| Method | getItemSearchOrderRecord | ||
| Description |
Gets the item search order record corresponding to the
given item record | ||
| Parameters | osid.type.Type | itemRecordType | an item record type |
| Return | osid.assessment.records.ItemSearchOrderRecord | the item search order record | |
| Errors | NULL_ARGUMENT | itemRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(itemRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |