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

Interface	osid.checklist.mason.TodoProducerSmartChecklistSession
Implements	`osid.OsidSession`
Used By	`osid.checklist.mason.ChecklistMasonManager`
Used By	`osid.checklist.mason.ChecklistMasonProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic checklists. A `TodoProducerQuery` can be retrieved from this session and mapped to this `Checklist` to create a virtual collection of todo producers. The todo producers may be sequenced using the `TodoProducerSearchOrder` from this session. This `Checklist` has a default query that matches any todo producer and a default search order that specifies no sequencing. The queries may be examined using a `TodoProducerQueryInspector` . The query may be modified by converting the inspector back to a `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	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	getTodoProducerQuery
Description	Gets a todo producer query.
Return	`osid.checklist.mason.TodoProducerQuery`		the todo producer query
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducerSearchOrder
Description	Gets a todo producer search order.
Return	`osid.checklist.mason.TodoProducerSearchOrder`		the todo producer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyTodoProducerQuery
Description	Applies a todo producer query to this checklist.
Parameters	`osid.checklist.mason.TodoProducerQuery`	`todoProducerQuery`	the todo producer query
Errors	NULL_ARGUMENT		`todoProducerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`todoProducerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectTodoProducerQuery
Description	Gets a todo producer query inspector for this checklist.
Return	`osid.checklist.mason.TodoProducerQueryInspector`		the todo producer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyTodoProducerSequencing
Description	Applies a todo producer search order to this checklist.
Parameters	`osid.checklist.mason.TodoProducerSearchOrder`	`todoProducerSearchOrder`	the todo producer search order
Errors	NULL_ARGUMENT		`todoProducerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`todoProducerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducerQueryFromInspector
Description	Gets a todo producer query from an inspector.
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.