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

Interface	osid.checklist.mason.TodoProducerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.checklist.mason.TodoProducerSearchSession`
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 `TodoProducerQuery`. 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 Todo producers may have a query record indicated by their respective record types. The query record is accessed via the `TodoProducerQuery`.
Method	getChecklistId
Description	Gets the `Checklist` `Id` associated with this session.
Return	`osid.id.Id`		the `Checklist Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getChecklist
Description	Gets the `Checklist` associated with this session.
Return	`osid.checklist.Checklist`		the checklist
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchTodoProducers
Description	Tests if this user can perform `TodoProducer` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedChecklistView
Description	Federates the view for methods in this session. A federated view will include todo producers in checklists which are children of this broker in the checklist hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedChecklistView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this checklist only.
Compliance	`mandatory`		This method is must be implemented.
Method	getTodoProducerQuery
Description	Gets a todo producer query.
Return	`osid.checklist.mason.TodoProducerQuery`		the todo producer query
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducersByQuery
Description	Gets a list of `TodoProducers` matching the given todo producer query.
Parameters	`osid.checklist.mason.TodoProducerQuery`	`todoProducerQuery`	the todo producer query
Return	`osid.checklist.mason.TodoProducerList`		the returned `TodoProducerList`
Errors	NULL_ARGUMENT		`todoProducerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`todoProducerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.