Interface | osid.checklist.mason.TodoProducerSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing todo producer searches. | ||
Method | searchAmongTodoProducers | ||
Description |
Execute this search among the given list of todo producers. | ||
Parameters | osid.id.IdList | todoProducerIds | list of todo producers |
Errors | NULL_ARGUMENT | todoProducerIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderTodoProducerResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.checklist.mason.TodoProducerSearchOrder | todoProducerSearchOrder | todo producer search order |
Errors | NULL_ARGUMENT | todoProducerSearchOrder is null | |
UNSUPPORTED | todoProducerSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTodoProducerSearchRecord | ||
Description |
Gets the todo producer search record corresponding to
the given todo producer search record | ||
Parameters | osid.type.Type | todoProducerSearchRecordType | a todo producer search record type |
Return | osid.checklist.mason.records.TodoProducerSearchRecord | the todo producer search record | |
Errors | NULL_ARGUMENT | todoProducerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(todoProducerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |