OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.ActionEnablerRuleLookupSession
Implementsosid.OsidSession
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.
MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupActionEnablerRules
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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeActionEnablerRuleView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryActionEnablerRuleView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedSystemView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedSystemView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this system only.

CompliancemandatoryThis method is must be implemented.
MethodgetActionEnablerIdsForAction
Description

Gets the ActionEnabler Id associated with an Action.

Parametersosid.id.IdactionId Id of the Action
Returnosid.id.IdListthe action enabler Ids
ErrorsNOT_FOUND actionId is not found
NULL_ARGUMENT action is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActionEnablersForAction
Description

Gets the ActionEnablers associated with an Action.

Parametersosid.id.IdactionId Id of the Action
Returnosid.control.rules.ActionEnablerListthe action enablers
ErrorsNOT_FOUND actionId is not found
NULL_ARGUMENT actionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActionIdsForActionEnabler
Description

Gets the Action Ids mapped to an ActionEnabler.

Parametersosid.id.IdactionEnablerId Id of an ActionEnabler
Returnosid.id.IdListlist of action Ids
ErrorsNOT_FOUND actionEnablerId is not found
NULL_ARGUMENT actionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActionsForActionEnabler
Description

Gets the Actions mapped to an ActionEnabler.

Parametersosid.id.IdactionEnablerId Id of an ActionEnabler
Returnosid.control.ActionListlist of actions
ErrorsNOT_FOUND actionEnablerId is not found
NULL_ARGUMENT actionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.