OSID - osid.rules.RuleQuerySession Service Interface Definition

Interface	osid.rules.RuleQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching `Rule` objects. The search query is constructed using the `RuleQuery.` The rule record `Type` also specifies the record for the rule query. Rules may have a rule query record indicated by their respective record types. The rule query record is accessed via the `RuleQuery.` The returns in this session may not be cast directly to these interfaces.
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	useFederatedEngineView
Description	Federates the view for methods in this session. A federated view will include rules 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 retrievals to this engine only.
Compliance	`mandatory`		This method is must be implemented.
Method	canSearchRules
Description	Tests if this user can perform `Rule` searches. 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 opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuleQuery
Description	Gets a rule query.
Return	`osid.rules.RuleQuery`		the rule query
Compliance	`mandatory`		This method must be implemented.
Method	getRulesByQuery
Description	Gets a list of `Rules` matching the given rule query.
Parameters	`osid.rules.RuleQuery`	`ruleQuery`	the rule query
Return	`osid.rules.RuleList`		the returned `RuleList`
Errors	NULL_ARGUMENT		`ruleQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`ruleQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.