OSID - osid.checklist.TodoQuerySession Service Interface Definition

Interface	osid.checklist.TodoQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching `Todo` objects. The search query is constructed using the `TodoQuery.` The todo record `Type` also specifies the record for the todo query. This session defines views that offer differing behaviors for searching. isolated checklist view: All todo methods in this session operate, retrieve and pertain to todos defined explicitly in the current checklist. Using an isolated view is useful for managing todos with the TodoAdminSession. federated checklist view: All todo lookup methods in this session operate, retrieve and pertain to all todos defined in this checklist and any other checklists implicitly available in this checklist through checklist inheritence. sequestered todo viiew: All event methods suppress sequestered todos. unsequestered todo view: All event methods return all todos. 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	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	canSearchTodos
Description	Tests if this user can perform todo searches. 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 wish to offer search 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 todos in checklists which are children of this checklist 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 searches to this checklist only.
Compliance	`mandatory`		This method is must be implemented.
Method	useSequesteredTodoView
Description	The returns from the search methods omit sequestered todos.
Compliance	`mandatory`		This method is must be implemented.
Method	useUnsequesteredTodoView
Description	All todos are returned including sequestered todos.
Compliance	`mandatory`		This method is must be implemented.
Method	getTodoQuery
Description	Gets a todo query.
Return	`osid.checklist.TodoQuery`		the todo query
Compliance	`mandatory`		This method must be implemented.
Method	getTodosByQuery
Description	Gets a list of todos matching the given search.
Parameters	`osid.checklist.TodoQuery`	`todoQuery`	the search query array
Return	`osid.checklist.TodoList`		the returned `TodoList`
Errors	NULL_ARGUMENT		`todoQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`todoQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.