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

Interface	osid.rules.check.InstructionSmartEngineSession
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. An `InstructionQuery` can be retrieved from this session and engineped to this `Engine` to create a virtual collection of `Instructions`. The instructions may be sequenced using the `InstructionSearchOrder` from this session. This `Engine` has a default query that matches any instruction and a default search order that specifies no sequencing. The queries may be examined using an `InstructionQueryInspector`. The query may be modified by converting the inspector back to an `InstructionQuery`.
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	getInstructionQuery
Description	Gets an instruction query.
Return	`osid.rules.check.InstructionQuery`		the instruction query
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionSearchOrder
Description	Gets an instruction search order.
Return	`osid.rules.check.InstructionSearchOrder`		the instruction search order
Compliance	`mandatory`		This method must be implemented.
Method	applyInstructionQuery
Description	Applies an instruction query to this engine.
Parameters	`osid.rules.check.InstructionQuery`	`instructionQuery`	the instruction query
Errors	NULL_ARGUMENT		`instructionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`instructionQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspecInstructionQuery
Description	Gets an instruction query inspector for this engine.
Return	`osid.rules.check.InstructionQueryInspector`		the instruction query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyInstructionSequencing
Description	Applies an instruction search order to this engine.
Parameters	`osid.rules.check.InstructionSearchOrder`	`instructionSearchOrder`	the instruction search order
Errors	NULL_ARGUMENT		`instructionSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`instructionSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionQueryFromInspector
Description	Gets an instruction query from an inspector.
Parameters	`osid.rules.check.InstructionQueryInspector`	`instructionQueryInspector`	an instruction query inspector
Return	`osid.rules.check.InstructionQuery`		the instruction query
Errors	NULL_ARGUMENT		`instructionQueryInspector` is `null`
Errors	UNSUPPORTED		`instructionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.