OSID Logo
OSID Specifications
checklist mason package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.mason.TodoProducerSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetTodoProducers
Description

Gets the TodoProducerList resulting from a search.

Returnosid.checklist.mason.TodoProducerListthe todo producer list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.checklist.mason.TodoProducerQueryInspectorthe todo producer query inspector
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerSearchResultsRecord
Description

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

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