org.osid.control.rules

Interface ActionEnablerRuleLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ActionEnablerRuleLookupSession
extends OsidSession

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 Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupActionEnablerRules() Tests if this user can perform lookups of action enabler/action mappings.
IdList	getActionEnablerIdsForAction(Id actionId) Gets the ActionEnabler Id associated with an Action.
ActionEnablerList	getActionEnablersForAction(Id actionId) Gets the ActionEnablers associated with an Action.
IdList	getActionIdsForActionEnabler(Id actionEnablerId) Gets the Action Ids mapped to an ActionEnabler.
ActionList	getActionsForActionEnabler(Id actionEnablerId) Gets the Actions mapped to an ActionEnabler.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
void	useComparativeActionEnablerRuleView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedSystemView() Federates the view for methods in this session.
void	useIsolatedSystemView() Isolates the view for methods in this session.
void	usePlenaryActionEnablerRuleView() A complete view of the ActionEnabler and Action returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getSystemId

Id getSystemId()

Gets the System Id associated with this session.

Returns:

the System Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystem

System getSystem()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the System associated with this session.

Returns:

the system

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupActionEnablerRules

boolean canLookupActionEnablerRules()

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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeActionEnablerRuleView

void useComparativeActionEnablerRuleView()

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.

usePlenaryActionEnablerRuleView

void usePlenaryActionEnablerRuleView()

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.

useFederatedSystemView

void useFederatedSystemView()

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.

useIsolatedSystemView

void useIsolatedSystemView()

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.

getActionEnablerIdsForAction

IdList getActionEnablerIdsForAction(Id actionId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Gets the ActionEnabler Id associated with an Action.

Parameters:

actionId - Id of the Action

Returns:

the action enabler Ids

Throws:

NotFoundException - actionId is not found

NullArgumentException - action is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionEnablersForAction

ActionEnablerList getActionEnablersForAction(Id actionId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Gets the ActionEnablers associated with an Action.

Parameters:

actionId - Id of the Action

Returns:

the action enablers

Throws:

NotFoundException - actionId is not found

NullArgumentException - actionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionIdsForActionEnabler

IdList getActionIdsForActionEnabler(Id actionEnablerId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Gets the Action Ids mapped to an ActionEnabler.

Parameters:

actionEnablerId - Id of an ActionEnabler

Returns:

list of action Ids

Throws:

NotFoundException - actionEnablerId is not found

NullArgumentException - actionEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionsForActionEnabler

ActionList getActionsForActionEnabler(Id actionEnablerId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Gets the Actions mapped to an ActionEnabler.

Parameters:

actionEnablerId - Id of an ActionEnabler

Returns:

list of actions

Throws:

NotFoundException - actionEnablerId is not found

NullArgumentException - actionEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.