Package org.alfresco.service.cmr.action

Interface ActionService

  • All Known Implementing Classes:
    ActionServiceImpl
    @AlfrescoPublicApi
public interface ActionService
    Action service interface
    Author:
    Roy Wetherall

    • Method Detail

      • getActionDefinition

        @Auditable(parameters="name")
ActionDefinition getActionDefinition​(java.lang.String name)
        Get a named action definition
        Parameters:
        name - the name of the action definition
        Returns:
        the action definition

      • getActionDefinitions

        @Auditable
java.util.List<ActionDefinition> getActionDefinitions()
        Get all the action definitions
        Returns:
        the list action definitions

      • getActionDefinitions

        @Auditable(parameters="nodeRef")
java.util.List<ActionDefinition> getActionDefinitions​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Get all the action definitions that are applicable for the given node, based on its type and aspects.
        Parameters:
        nodeRef - the node reference
        Returns:
        a list of applicable action definitions

      • getActionConditionDefinition

        @Auditable(parameters="name")
ActionConditionDefinition getActionConditionDefinition​(java.lang.String name)
        Get a named action condition definition
        Parameters:
        name - the name of the action condition definition
        Returns:
        the action condition definition

      • getActionConditionDefinitions

        @Auditable(parameters={})
java.util.List<ActionConditionDefinition> getActionConditionDefinitions()
        Get all the action condition definitions
        Returns:
        the list of action condition definitions

      • getParameterConstraint

        @Auditable(parameters="name")
ParameterConstraint getParameterConstraint​(java.lang.String name)
        Get a named parameter constraint
        Parameters:
        name - the name of the parameter constraint
        Returns:
        this parameter condition

      • getParameterConstraints

        @Auditable(parameters={})
java.util.List<ParameterConstraint> getParameterConstraints()
        Get all the parameter constraints
        Returns:
        the list of all parameter constraints

      • createAction

        @Auditable(parameters="name")
Action createAction​(java.lang.String name)
        Create a new action
        Parameters:
        name - the action definition name
        Returns:
        the action

      • createAction

        @Auditable(parameters={"name","params"})
Action createAction​(java.lang.String name,
                    java.util.Map<java.lang.String,​java.io.Serializable> params)
        Create a new action specifying the initial set of parameter values
        Parameters:
        name - the action definition name
        params - the parameter values
        Returns:
        the action

      • createCompositeAction

        @Auditable
CompositeAction createCompositeAction()
        Create a composite action
        Returns:
        the composite action

      • createActionCondition

        @Auditable(parameters="name")
ActionCondition createActionCondition​(java.lang.String name)
        Create an action condition
        Parameters:
        name - the action condition definition name
        Returns:
        the action condition

      • createActionCondition

        @Auditable(parameters={"name","params"})
ActionCondition createActionCondition​(java.lang.String name,
                                      java.util.Map<java.lang.String,​java.io.Serializable> params)
        Create an action condition specifying the initial set of parameter values
        Parameters:
        name - the action condition definition name
        params - the parameter values
        Returns:
        the action condition

      • createCompositeActionCondition

        @Auditable
CompositeActionCondition createCompositeActionCondition()
        Create a composite actionCondition
        Returns:
        the composite actionCondition

      • executeAction

        @Auditable(parameters={"action","actionedUponNodeRef"})
void executeAction​(Action action,
                   org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
        The actions conditions are always checked.
        Parameters:
        action - the action
        actionedUponNodeRef - the actioned upon node reference
        See Also:
        executeAction(Action, NodeRef, boolean)

      • executeAction

        @Auditable(parameters={"action","actionedUponNodeRef","checkConditions"})
void executeAction​(Action action,
                   org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
                   boolean checkConditions)
        The action is executed based on the asynchronous attribute of the action.
        Parameters:
        action - the action
        actionedUponNodeRef - the actioned upon node reference
        checkConditions - indicates whether the conditions should be checked
        See Also:
        executeAction(Action, NodeRef, boolean, boolean)

      • executeAction

        @Auditable(parameters={"action","actionedUponNodeRef","checkConditions","executeAsynchronously"})
void executeAction​(Action action,
                   org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
                   boolean checkConditions,
                   boolean executeAsynchronously)
        Executes the specified action upon the node reference provided.

        If specified that the conditions should be checked then any conditions set on the action are evaluated.

        If the conditions fail then the action is not executed.

        If an action has no conditions then the action will always be executed.

        If the conditions are not checked then the action will always be executed.

        Parameters:
        action - the action
        actionedUponNodeRef - the actioned upon node reference
        checkConditions - indicates whether the conditions should be checked before executing the action
        executeAsynchronously - indicates whether the action should be executed asychronously or not, this value overrides the value set on the action its self

      • evaluateAction

        @Auditable(parameters={"action","actionedUponNodeRef"})
boolean evaluateAction​(Action action,
                       org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
        Evaluted the conditions set on an action.

        Returns true if the action has no conditions.

        If the action has more than one condition their results are combined using the 'AND' logical operator.

        Parameters:
        action - the action
        actionedUponNodeRef - the actioned upon node reference
        Returns:
        true if the condition succeeds, false otherwise

      • evaluateActionCondition

        @Auditable(parameters={"condition","actionedUponNodeRef"})
boolean evaluateActionCondition​(ActionCondition condition,
                                org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
        Evaluate an action condition.
        Parameters:
        condition - the action condition
        actionedUponNodeRef - the actioned upon node reference
        Returns:
        true if the condition succeeds, false otherwise

      • saveAction

        @Auditable(parameters={"nodeRef","action"})
void saveAction​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                Action action)
        Save an action against a node reference.

        The node will be made configurable if it is not already.

        If the action already exists then its details will be updated.

        Parameters:
        nodeRef - the node reference
        action - the action

      • getActions

        @Auditable(parameters="nodeRef")
java.util.List<Action> getActions​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Gets all the actions currently saved on the given node reference.
        Parameters:
        nodeRef - the node reference
        Returns:
        the list of actions

      • getAction

        @Auditable(parameters={"nodeRef","actionId"})
Action getAction​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                 java.lang.String actionId)
        Gets an action stored against a given node reference.

        Returns null if the action can not be found.

        Parameters:
        nodeRef - the node reference
        actionId - the action id
        Returns:
        the action

      • removeAction

        @Auditable(parameters={"nodeRef","action"})
void removeAction​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                  Action action)
        Removes an action associated with a node reference.
        Parameters:
        nodeRef - the node reference
        action - the action

      • removeAllActions

        @Auditable(parameters="nodeRef")
void removeAllActions​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Removes all actions associated with a node reference
        Parameters:
        nodeRef - the node reference