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

Interface	osid.rules.check.InstructionQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Instruction` objects. The search query is constructed using the `InstructionQuery.` This session defines views that offer differing behaviors for searching. federated engine view: searches include instructions in engines of which this engine is an ancestor in the engine hierarchy isolated engine view: searches are restricted to instructions in this engine Instructions may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchInstructions
Description	Tests if this user can perform `Instruction` lookups. 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 offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedEngineView
Description	Federates the view for methods in this session. A federated view will include instructions in engines which are children of this engine in the engine hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedEngineView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this engine only.
Compliance	`mandatory`		This method is 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	getInstructionsByQuery
Description	Gets a list of `Instructions` matching the given instruction query.
Parameters	`osid.rules.check.InstructionQuery`	`instructionQuery`	the instruction query
Return	`osid.rules.check.InstructionList`		the returned `InstructionList`
Errors	NULL_ARGUMENT		`instructionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`instructionQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.