OSID Logo
OSID Specifications
checklist mason package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.mason.TodoProducerSearch
Implementsosid.OsidSearch
Description

The search interface for governing todo producer searches.

MethodsearchAmongTodoProducers
Description

Execute this search among the given list of todo producers.

Parametersosid.id.IdListtodoProducerIdslist of todo producers
ErrorsNULL_ARGUMENT todoProducerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderTodoProducerResults
Description

Specify an ordering to the search results.

Parametersosid.checklist.mason.TodoProducerSearchOrdertodoProducerSearchOrdertodo producer search order
ErrorsNULL_ARGUMENT todoProducerSearchOrder is null
UNSUPPORTED todoProducerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerSearchRecord
Description

Gets the todo producer search record corresponding to the given todo producer search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypetodoProducerSearchRecordTypea todo producer search record type
Returnosid.checklist.mason.records.TodoProducerSearchRecordthe todo producer search record
ErrorsNULL_ARGUMENT todoProducerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(todoProducerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.