com.edorasware.one.action

Interface ActionManager

All Known Implementing Classes:

DefaultActionManager

public interface ActionManager

Method Summary

Modifier and Type	Method and Description
Action	getActionByGlobalId(String actionId, String globalId, Locale locale) Returns the Action instance for the given action id.
List<Action>	getAllowedActions(ActionContext actionContext, Locale locale) Returns the allowed Actions for the specified context and the work object id.
List<ActionGroup>	getAllowedActions(String context, String globalId, Locale locale) Returns the allowed ActionGroups for the specified context and the work object id.
List<Action>	getAllowedActionsForType(String type, Optional<String> qualifier, Locale locale) Returns the allowed Actions for the specified Type.

Method Detail

getAllowedActions

List<ActionGroup> getAllowedActions(String context,
                                    String globalId,
                                    Locale locale)

Returns the allowed ActionGroups for the specified context and the work object id. The privileges of the current user are also involved in the permission process.

Parameters:

context - the action context for which the allowed actions should be returned

globalId - the work object global id for which the allowed actions should be returned

locale - the translation locale

Returns:

the grouped allowed actions for the specified action context and work object id

Throws:

IllegalArgumentException - if an input parameter is not valid

RuntimeException - if an error occurs while getting the allowed actions for the current user

getAllowedActions

List<Action> getAllowedActions(ActionContext actionContext,
                               Locale locale)

Returns the allowed Actions for the specified context and the work object id. The privileges of the current user are also involved in the permission process.

Parameters:

actionContext - the action context for which the allowed actions should be returned

locale - the translation locale

Returns:

the allowed actions for the specified action context and work object id

Throws:

IllegalArgumentException - if an input parameter is not valid

RuntimeException - if an error occurs while getting the allowed actions for the current user

getAllowedActionsForType

List<Action> getAllowedActionsForType(String type,
                                      Optional<String> qualifier,
                                      Locale locale)

Returns the allowed Actions for the specified Type.

Parameters:

type - the type for which to retrieve the actions

qualifier - action type qualifier

locale - the translation locale

Returns:

the allowed actions for the specified type

Throws:

IllegalArgumentException - if the type is not known

RuntimeException - if an error occurs while getting the allowed actions for the type

getActionByGlobalId

Action getActionByGlobalId(String actionId,
                           String globalId,
                           Locale locale)

Returns the Action instance for the given action id. If the id is not known a generated "unknown" action is returned.

Parameters:

actionId - the action id for which the action instance should be created

globalId - the work object global id for which the action should be returned

locale - the translation locale

Returns:

the action instance for the given action name

Throws:

RuntimeException - if the action is not allowed in the context of the given work object id