Interface | osid.checklist.TodoSearchSession | ||
---|---|---|---|
Implements | osid.checklist.TodoQuerySession | ||
Description |
This session provides methods for searching Todos may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getTodoSearch | ||
Description |
Gets a todo search. | ||
Return | osid.checklist.TodoSearch | the todo search | |
Compliance | mandatory | This method must be implemented. | |
Method | getTodoSearchOrder | ||
Description |
Gets a todo search order. The | ||
Return | osid.checklist.TodoSearchOrder | the todo search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getTodosBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.checklist.TodoQuery | todoQuery | the todo query |
osid.checklist.TodoSearch | todoSearch | the todo search | |
Return | osid.checklist.TodoSearchResults | the search results | |
Errors | NULL_ARGUMENT | todoQuery or todoSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | todoQuery or todoSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTodoQueryFromInspector | ||
Description |
Gets an entry query from an inspector. The inspector is
available from an | ||
Parameters | osid.checklist.TodoQueryInspector | todoQueryInspector | a todo query inspector |
Return | osid.checklist.TodoQuery | the entry query | |
Errors | NULL_ARGUMENT | todoQueryInspector is null | |
UNSUPPORTED | todoQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |