OSID - osid.rules.check.CheckSmartEngineSession Service Interface Definition

Interface	osid.rules.check.CheckSmartEngineSession
Implements	`osid.OsidSession`
Used By	`osid.rules.check.RulesCheckManager`
Used By	`osid.rules.check.RulesCheckProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CheckQuery` can be retrieved from this session and engineped to this `Engine` to create a virtual collection of `Checks`. The checks may be sequenced using the `CheckSearchOrder` from this session. This `Engine` has a default query that matches any check and a default search order that specifies no sequencing. The queries may be examined using a `CheckQueryInspector`. The query may be modified by converting the inspector back to a `CheckQuery`.
Method	getEngineId
Description	Gets the `Engine` `Id` associated with this session.
Return	`osid.id.Id`		the `Engine Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getEngine
Description	Gets the `Engine` associated with this session.
Return	`osid.rules.Engine`		the engine
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartEngines
Description	Tests if this user can manage smart engines. 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 engine management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCheckQuery
Description	Gets a check query.
Return	`osid.rules.check.CheckQuery`		the check query
Compliance	`mandatory`		This method must be implemented.
Method	getCheckSearchOrder
Description	Gets a check search order.
Return	`osid.rules.check.CheckSearchOrder`		the check search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCheckQuery
Description	Applies a check query to this engine.
Parameters	`osid.rules.check.CheckQuery`	`checkQuery`	the check query
Errors	NULL_ARGUMENT		`checkQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`checkQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCheckQuery
Description	Gets a check query inspector for this engine.
Return	`osid.rules.check.CheckQueryInspector`		the check query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCheckSequencing
Description	Applies a check search order to this engine.
Parameters	`osid.rules.check.CheckSearchOrder`	`checkSearchOrder`	the check search order
Errors	NULL_ARGUMENT		`checkSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`checkSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCheckQueryFromInspector
Description	Gets a check query from an inspector.
Parameters	`osid.rules.check.CheckQueryInspector`	`checkQueryInspector`	a check query inspector
Return	`osid.rules.check.CheckQuery`		the check query
Errors	NULL_ARGUMENT		`checkQueryInspector` is `null`
Errors	UNSUPPORTED		`checkQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.