| Interface | osid.checklist.TodoSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidContainableSearchOrder | |||
osid.OsidTemporalSearchOrder | |||
osid.OsidFederateableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByComplete | ||
| Description |
Specifies a preference for ordering the result set by the completed status. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPriority | ||
| Description |
Specifies a preference for ordering the result set by the priority. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDueDate | ||
| Description |
Specifies a preference for ordering the result set by the due date. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTodoSearchOrderRecord | ||
| Description |
Gets the todo search order record corresponding to the
given todo record | ||
| Parameters | osid.type.Type | todoRecordType | a todo record type |
| Return | osid.checklist.records.TodoSearchOrderRecord | the todo search order record | |
| Errors | NULL_ARGUMENT | todoRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(todoRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |