Interface | osid.checklist.mason.TodoProducerSearchSession | ||
---|---|---|---|
Implements | osid.checklist.mason.TodoProducerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getTodoProducerSearch | ||
Description |
Gets a todo producer search. | ||
Return | osid.checklist.mason.TodoProducerSearch | the todo producer search | |
Compliance | mandatory | This method must be implemented. | |
Method | getTodoProducerSearchOrder | ||
Description |
Gets a todo producer search order. The | ||
Return | osid.checklist.mason.TodoProducerSearchOrder | the todo producer search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getTodoProducersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.checklist.mason.TodoProducerQuery | todoProducerQuery | the todo producer query |
osid.checklist.mason.TodoProducerSearch | todoProducerSearch | the todo producer search | |
Return | osid.checklist.mason.TodoProducerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | todoProducerQuery or todoProducerSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | todoProducerQuery or todoProducerSearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTodoProducerQueryFromInspector | ||
Description |
Gets a todo producer query from an inspector. The
inspector is available from a | ||
Parameters | osid.checklist.mason.TodoProducerQueryInspector | todoProducerQueryInspector | a todo producer query inspector |
Return | osid.checklist.mason.TodoProducerQuery | the todo producer query | |
Errors | NULL_ARGUMENT | todoProducerQueryInspector is null | |
UNSUPPORTED | todoProducerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |