com.edorasware.one.action

Interface ActionManager

public interface ActionManager

Method Summary

Modifier and Type	Method and Description
Action	getActionById(String actionId, com.edorasware.commons.core.entity.GlobalId globalId) Returns the Action instance for the given action id.
com.google.common.collect.ImmutableCollection<Action>	getAllowedActions(String context, com.edorasware.commons.core.entity.GlobalId globalId) Returns the allowed Actions for the specified context and the work object id.
com.google.common.collect.ImmutableCollection<Action>	getAllowedActionsForType(com.edorasware.commons.core.entity.Type type, com.google.common.base.Optional<String> qualifier) Returns the allowed Actions for the specified Type.

Method Detail

getAllowedActions

com.google.common.collect.ImmutableCollection<Action> getAllowedActions(String context,
                                                                        com.edorasware.commons.core.entity.GlobalId globalId)

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:

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

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

com.google.common.collect.ImmutableCollection<Action> getAllowedActionsForType(com.edorasware.commons.core.entity.Type type,
                                                                               com.google.common.base.Optional<String> qualifier)

Returns the allowed Actions for the specified Type.

Parameters:

type - the type for which to retrieve the actions

qualifier - action type qualifier

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

getActionById

Action getActionById(String actionId,
                     com.edorasware.commons.core.entity.GlobalId globalId)

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

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