OSID Logo
OSID Specifications
checklist mason package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.mason.TodoProducerSearchSession
Implementsosid.checklist.mason.TodoProducerQuerySession
Description

This session provides methods for searching among TodoProducer objects. The search query is constructed using the TodoProduceryQuery.

getTodoProducersByQuery() is the basic search method and returns a list of TodoProducers. A more advanced search may be performed with getTodoProducersBySearch(). It accepts a TodoProducerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getTodoProducersBySearch() returns a TodoProducerSearchResults that can be used to access the resulting TodoProducerList or be used to perform a search within the result set through TodoProducerSearch.

This session defines views that offer differing behaviors for searching.

  • federated checklist view: searches include todo producers in checklists of which this checklist is an ancestor in the checklist hierarchy
  • isolated checklist view: searches are restricted to todo producers in this checklist

TodoProducers may have a query record indicated by their respective record types. The query record is accessed via the TodoProducerQuery.

MethodgetTodoProducerSearch
Description

Gets a todo producer search.

Returnosid.checklist.mason.TodoProducerSearchthe todo producer search
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerSearchOrder
Description

Gets a todo producer search order. The TodoProducerSearchOrder is supplied to a TodoProducerSearch to specify the ordering of results.

Returnosid.checklist.mason.TodoProducerSearchOrderthe todo producer search order
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducersBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.checklist.mason.TodoProducerQuerytodoProducerQuerythe todo producer query
osid.checklist.mason.TodoProducerSearchtodoProducerSearchthe todo producer search
Returnosid.checklist.mason.TodoProducerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT todoProducerQuery or todoProducerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED todoProducerQuery or todoProducerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerQueryFromInspector
Description

Gets a todo producer query from an inspector. The inspector is available from a TodoProducerSearchResults.

Parametersosid.checklist.mason.TodoProducerQueryInspectortodoProducerQueryInspectora todo producer query inspector
Returnosid.checklist.mason.TodoProducerQuerythe todo producer query
ErrorsNULL_ARGUMENT todoProducerQueryInspector is null
UNSUPPORTED todoProducerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.