OSID - osid.rules.RuleLookupSession Service Interface Definition

Interface	osid.rules.RuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.rules.RulesManager`
Used By	`osid.rules.RulesProxyManager`
Description	This session provides methods for retrieving `Rules`. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated engine view: All rule methods in this session operate, retrieve and pertain to rules defined explicitly in the current engine. federated engine view: All rule methods in this session operate, retrieve and pertain to all rules defined in this engine and any other rules implicitly available in this engine through engine inheritence. active rule view: All rule lookup methods return active rules. any status rule view: Rules of any active or inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the `Rules` it can access, without breaking execution. However, an assessment may only be useful if all `Rules` referenced by it are available, and a test-taking applicationmay sacrifice some interoperability for the sake of precision.
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	canLookupRules
Description	Tests if this user can perform `Rule` 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 opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryRuleView
Description	A complete view of the `Rule` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is 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	useActiveRuleView
Description	Only active rules are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusRuleView
Description	All active and inactive rules are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getRule
Description	Gets the `Rule` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Rule` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Rule` and retained for compatibility. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
Parameters	`osid.id.Id`	`ruleId`	`Id` of the `Rule`
Return	`osid.rules.Rule`		the rule
Errors	NOT_FOUND		`ruleId` not found
	NULL_ARGUMENT		`ruleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getRulesByIds
Description	Gets a `RuleList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the rules specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Rules` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
Parameters	`osid.id.IdList`	`ruleIds`	the list of `Ids` to retrieve
Return	`osid.rules.RuleList`		the returned `Rule` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`ruleIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRulesByGenusType
Description	Gets a `RuleList` corresponding to the given rule genus `Type` which does not include rules of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known rules or an error results. Otherwise, the returned list may contain only those rules that are accessible through this session. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
Parameters	`osid.type.Type`	`ruleGenusType`	a rule genus type
Return	`osid.rules.RuleList`		the returned `Rule` list
Errors	NULL_ARGUMENT		`ruleGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRulesByParentGenusType
Description	Gets a `RuleList` corresponding to the given rule genus `Type` and include any additional rules with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known rules or an error results. Otherwise, the returned list may contain only those rules that are accessible through this session. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
Parameters	`osid.type.Type`	`ruleGenusType`	a rule genus type
Return	`osid.rules.RuleList`		the returned `Rule` list
Errors	NULL_ARGUMENT		`ruleGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRulesByRecordType
Description	Gets a `RuleList` containing the given repository record `Type`. In plenary mode, the returned list contains all known rules or an error results. Otherwise, the returned list may contain only those rules that are accessible through this session. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
Parameters	`osid.type.Type`	`ruleRecordType`	a rule record type
Return	`osid.rules.RuleList`		the returned `Rule` list
Errors	NULL_ARGUMENT		`ruleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRules
Description	Gets all `Rules`. In plenary mode, the returned list contains all known rules or an error results. Otherwise, the returned list may contain only those rules that are accessible through this session. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
Return	`osid.rules.RuleList`		a list of `Rules`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.