Package org.alfresco.repo.action

Interface RuntimeActionService

  • All Known Implementing Classes:
    ActionServiceImpl
    public interface RuntimeActionService
    Runtime action service. This interface contains methods useful for integration with the action service at a lower level.
    Author:
    Roy Wetherall

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Action createAction​(org.alfresco.service.cmr.repository.NodeRef actionNodeRef)
      Create a new action based on an action node reference
      org.alfresco.service.cmr.repository.NodeRef createActionNodeRef​(Action action, org.alfresco.service.cmr.repository.NodeRef parentNodeRef, org.alfresco.service.namespace.QName assocTypeName, org.alfresco.service.namespace.QName assocName)
      Create a action node reference
      void directActionExecution​(Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
      Execute an action directly
      void executeActionImpl​(Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef, boolean checkConditions, boolean executedAsynchronously, java.util.Set<java.lang.String> actionChain)
      Perform low-level action execution
      boolean onLogException​(Action action, org.apache.commons.logging.Log logger, java.lang.Throwable t, java.lang.String message)
      Optional logging of errors callback for the action executer for the cases when the error might be ignored or shown in a different manner for the action
      void postCommit()
      Post commit method
      void registerActionConditionEvaluator​(ActionConditionEvaluator actionConditionEvaluator)
      Register an action condition evaluator
      void registerActionExecuter​(ActionExecuter actionExecuter)
      Register an action executer
      void registerParameterConstraint​(ParameterConstraint parameterConstraint)
      Register parameter constraint
      void saveActionImpl​(org.alfresco.service.cmr.repository.NodeRef actionNodeRef, Action action)
      Save action, used internally to store the details of an action on the aciton node.

    • Method Detail

      • postCommit

        void postCommit()
        Post commit method

      • registerActionConditionEvaluator

        void registerActionConditionEvaluator​(ActionConditionEvaluator actionConditionEvaluator)
        Register an action condition evaluator
        Parameters:
        actionConditionEvaluator - action condition evaluator

      • registerActionExecuter

        void registerActionExecuter​(ActionExecuter actionExecuter)
        Register an action executer
        Parameters:
        actionExecuter - action executer

      • registerParameterConstraint

        void registerParameterConstraint​(ParameterConstraint parameterConstraint)
        Register parameter constraint
        Parameters:
        parameterConstraint - parameter constraint

      • createAction

        Action createAction​(org.alfresco.service.cmr.repository.NodeRef actionNodeRef)
        Create a new action based on an action node reference
        Parameters:
        actionNodeRef - action node reference
        Returns:
        Action action object

      • createActionNodeRef

        org.alfresco.service.cmr.repository.NodeRef createActionNodeRef​(Action action,
                                                                org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
                                                                org.alfresco.service.namespace.QName assocTypeName,
                                                                org.alfresco.service.namespace.QName assocName)
        Create a action node reference
        Parameters:
        action - action object
        parentNodeRef - parent node reference
        assocTypeName - association type name
        assocName - association name
        Returns:
        NodeRef created node reference

      • saveActionImpl

        void saveActionImpl​(org.alfresco.service.cmr.repository.NodeRef actionNodeRef,
                    Action action)
        Save action, used internally to store the details of an action on the aciton node.
        Parameters:
        actionNodeRef - the action node reference
        action - the action

      • executeActionImpl

        void executeActionImpl​(Action action,
                       org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
                       boolean checkConditions,
                       boolean executedAsynchronously,
                       java.util.Set<java.lang.String> actionChain)
        Perform low-level action execution

      • directActionExecution

        void directActionExecution​(Action action,
                           org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
        Execute an action directly
        Parameters:
        action - the action
        actionedUponNodeRef - the actioned upon node reference

      • onLogException

        boolean onLogException​(Action action,
                       org.apache.commons.logging.Log logger,
                       java.lang.Throwable t,
                       java.lang.String message)
        Optional logging of errors callback for the action executer for the cases when the error might be ignored or shown in a different manner for the action
        Parameters:
        action - the action
        logger - the logger
        t - the exception thrown
        message - the proposed message that will be logged
        Returns:
        true if it was handled, false for default handling