OSID - osid.checklist.mason.TodoProducerSearchSession Service Interface Definition

Interface	osid.checklist.mason.TodoProducerSearchSession
Implements	`osid.checklist.mason.TodoProducerQuerySession`
Used By	`osid.checklist.mason.ChecklistMasonManager`
Used By	`osid.checklist.mason.ChecklistMasonProxyManager`
Description	This session provides methods for searching among `TodoProducers` . 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` .
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 `TodoProducerSearchOrder` is supplied to a `TodoProducerSearch` to specify the ordering of results.
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
Parameters	`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 `TodoProducerSearchResults` .
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`
Errors	UNSUPPORTED		`todoProducerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.