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

Interface	osid.rules.check.CheckQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.rules.check.CheckSearchSession`
Used By	`osid.rules.check.RulesCheckManager`
Used By	`osid.rules.check.RulesCheckProxyManager`
Description	This session provides methods for searching among `Check` objects. The search query is constructed using the `CheckQuery`. This session defines views that offer differing behaviors for searching. federated engine view: searches include checks in engines of which this engine is an ancestor in the engine hierarchy isolated engine view: searches are restricted to checks in this engine Checks may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchChecks
Description	Tests if this user can perform `Check` 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 checks 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 searches to this engine only.
Compliance	`mandatory`		This method is 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	getChecksByQuery
Description	Gets a list of `Checks` matching the given check query.
Parameters	`osid.rules.check.CheckQuery`	`checkQuery`	the check query
Return	`osid.rules.check.CheckList`		the returned `CheckList`
Errors	NULL_ARGUMENT		`checkQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`checkQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.