OSID - osid.checklist.TodoSearchSession Service Interface Definition

Interface	osid.checklist.TodoSearchSession
Implements	`osid.checklist.TodoQuerySession`
Used By	`osid.checklist.ChecklistManager`
Used By	`osid.checklist.ChecklistProxyManager`
Description	This session provides methods for searching `Todos`. The search query is constructed using the `TodoQuery`. The todo record `Type` also specifies the record for the todo query. `getTodosByQuery()` is the basic search method and returns a list of `Todo` elements. A more advanced search may be performed with `getTodosBySearch()`. It accepts a `TodoSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getTodosBySearch()` returns a `TodoSearchResults` that can be used to access the resulting `TodoList` or be used to perform a search within the result set through `TodoSearch`. Todos may have a query record indicated by their respective record types. The query record is accessed via the `TodoQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getTodoSearch
Description	Gets a todo search.
Return	`osid.checklist.TodoSearch`		the todo search
Compliance	`mandatory`		This method must be implemented.
Method	getTodoSearchOrder
Description	Gets a todo search order. The `TodoSearchOrder` is supplied to a `TodoSearch` to specify the ordering of results.
Return	`osid.checklist.TodoSearchOrder`		the todo search order
Compliance	`mandatory`		This method must be implemented.
Method	getTodosBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.checklist.TodoQuery`	`todoQuery`	the todo query
Parameters	`osid.checklist.TodoSearch`	`todoSearch`	the todo search
Return	`osid.checklist.TodoSearchResults`		the search results
Errors	NULL_ARGUMENT		`todoQuery` or `todoSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`todoQuery` or `todoSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getTodoQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `TodoSearchResults`.
Parameters	`osid.checklist.TodoQueryInspector`	`todoQueryInspector`	a todo query inspector
Return	`osid.checklist.TodoQuery`		the entry query
Errors	NULL_ARGUMENT		`todoQueryInspector` is `null`
Errors	UNSUPPORTED		`todoQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.