OSID - osid.checklist.TodoSmartChecklistSession Service Interface Definition

Interface	osid.checklist.TodoSmartChecklistSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `TodoQuery` can be retrieved from this session and mapped to this `Checklist` to create a virtual collection of `Todos.` The todos may be sequenced using the `TodoSearchOrder` from this session. This `Checklist` has a default query that matches any todo and a default search order that specifies no sequencing. The queries may be examined using a `TodoQueryInspector.` The query may be modified by converting the inspector back to a `TodoQuery.`
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartChecklists
Description	Tests if this user can manage smart checklists. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart checklist management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getTodoSearchOrder
Description	Gets a todo search order.
Return	`osid.checklist.TodoSearchOrder`		the todo search order
Compliance	`mandatory`		This method must be implemented.
Method	applyTodoQuery
Description	Applies a todo query to this checklist.
Parameters	`osid.checklist.TodoQuery`	`todoQuery`	the todo query
Errors	NULL_ARGUMENT		`todoQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`todoQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectTodoQuery
Description	Gets a todo query inspector for this checklist.
Return	`osid.checklist.TodoQueryInspector`		the todo query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyTodoSequencing
Description	Applies a todo search order to this checklist.
Parameters	`osid.checklist.TodoSearchOrder`	`todoSearchOrder`	the todo search order
Errors	NULL_ARGUMENT		`todoSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`todoSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getTodoQueryFromInspector
Description	Gets a todo query from an inspector.
Parameters	`osid.checklist.TodoQueryInspector`	`todoQueryInspector`	a query inspector
Return	`osid.checklist.TodoQuery`		the todo query
Errors	NULL_ARGUMENT		`todoQueryInspector` is `null`
Errors	UNSUPPORTED		`todoQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.