OSID - osid.control.rules.ActionEnablerRuleLookupSession Service Interface Definition

Interface	osid.control.rules.ActionEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.control.rules.ControlRulesManager`
Used By	`osid.control.rules.ControlRulesProxyManager`
Description	This session provides methods to retrieve `ActionEnabler` to `Action` mappings. An `Action` with multiple `ActionEnablers` means any positive rule evaluation across the enablers result in an effective `Action`. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated system view: All methods in this session operate, retrieve and pertain action enablers defined explicitly in the current system federated system view: All methods in this session operate, retrieve and pertain to all action enablers defined in this system and any other action enablers implicitly available in this system through system inheritence.
Method	getSystemId
Description	Gets the `System` `Id` associated with this session.
Return	`osid.id.Id`		the `System Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSystem
Description	Gets the `System` associated with this session.
Return	`osid.control.System`		the system
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupActionEnablerRules
Description	Tests if this user can perform lookups of action enabler/action mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeActionEnablerRuleView
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	usePlenaryActionEnablerRuleView
Description	A complete view of the `ActionEnabler` and `Action` 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	useFederatedSystemView
Description	Federates the view for methods in this session. A federated view will include action enablers in systems which are children of this system in the system hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedSystemView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this system only.
Compliance	`mandatory`		This method is must be implemented.
Method	getActionEnablerIdsForAction
Description	Gets the `ActionEnabler Id` associated with an `Action`.
Parameters	`osid.id.Id`	`actionId`	`Id` of the `Action`
Return	`osid.id.IdList`		the action enabler `Ids`
Errors	NOT_FOUND		`actionId` is not found
	NULL_ARGUMENT		`action` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActionEnablersForAction
Description	Gets the `ActionEnablers` associated with an `Action`.
Parameters	`osid.id.Id`	`actionId`	`Id` of the `Action`
Return	`osid.control.rules.ActionEnablerList`		the action enablers
Errors	NOT_FOUND		`actionId` is not found
	NULL_ARGUMENT		`actionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActionIdsForActionEnabler
Description	Gets the `Action` `Ids` mapped to an `ActionEnabler`.
Parameters	`osid.id.Id`	`actionEnablerId`	`Id` of an `ActionEnabler`
Return	`osid.id.IdList`		list of action `Ids`
Errors	NOT_FOUND		`actionEnablerId` is not found
	NULL_ARGUMENT		`actionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActionsForActionEnabler
Description	Gets the `Actions` mapped to an `ActionEnabler`.
Parameters	`osid.id.Id`	`actionEnablerId`	`Id` of an `ActionEnabler`
Return	`osid.control.ActionList`		list of actions
Errors	NOT_FOUND		`actionEnablerId` is not found
	NULL_ARGUMENT		`actionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.