OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
checklist package
Version 3.0.0
Release Candidate Preview
| Interface | osid.checklist.TodoSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getTodos | ||
| Description |
Gets the todo list resulting from a search. | ||
| Return | osid.checklist.TodoList | the todo list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTodoQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.checklist.TodoQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTodoSearchResultsRecord | ||
| Description |
Gets the todo search results record corresponding to
the given todo search record | ||
| Parameters | osid.type.Type | todoSearchRecordType | a todo search record type |
| Return | osid.checklist.records.TodoSearchResultsRecord | the todo search results 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. | |