OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
checklist package
Version 3.0.0
Release Candidate Preview
| Interface | osid.checklist.TodoSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing todo searches. | ||
| Method | searchAmongTodos | ||
| Description |
Execute this search among the given list of todos. | ||
| Parameters | osid.id.IdList | todoIds | list of todos |
| Errors | NULL_ARGUMENT | todoIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderTodoResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.checklist.TodoSearchOrder | todoSearchOrder | todo search order |
| Errors | NULL_ARGUMENT | todoSearchOrder is null | |
| UNSUPPORTED | todoSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getTodoSearchRecord | ||
| Description |
Gets the todo search record corresponding to the given
todo search record | ||
| Parameters | osid.type.Type | todoSearchRecordType | a todo search record type |
| Return | osid.checklist.records.TodoSearchRecord | the todo search record | |
| Errors | NULL_ARGUMENT | todoSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(todoSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |