Package org.alfresco.repo.action.executer

Interface ActionExecuter

All Known Implementing Classes:
AbstractRenderingEngine, AbstractTransformationRenderingEngine, ActionExecuterAbstractBase, AddFailedThumbnailActionExecuter, AddFeaturesActionExecuter, BaseTemplateRenderingEngine, CancelWorkflowActionExecuter, CheckInActionExecuter, CheckOutActionExecuter, CompositeActionExecuter, CompositeRenderingEngine, ContentMetadataEmbedder, ContentMetadataExtracter, CopyActionExecuter, CountChildrenActionExecuter, CounterIncrementActionExecuter, CreateDownloadArchiveAction, CreateThumbnailActionExecuter, CreateTransferTargetActionExecuter, CreateVersionActionExecuter, DeleteRenditionActionExecuter, ExecuteAllRulesActionExecuter, ExporterActionExecuter, FreemarkerRenderingEngine, ImageRenderingEngine, ImageTransformActionExecuter, ImporterActionExecuter, LinkCategoryActionExecuter, LinkRules, MailActionExecuter, MoveActionExecuter, PerformRenditionActionExecuter, QuickShareLinkExpiryActionExecutor, ReformatRenderingEngine, RefreshTagScopeActionExecuter, RemoveFeaturesActionExecuter, ReorderRules, ReplicationActionExecutor, RepositoryExporterActionExecuter, ScriptActionExecuter, SetPropertyValueActionExecuter, SimpleWorkflowActionExecuter, SpecialiseTypeActionExecuter, StartWorkflowActionExecuter, TakeOwnershipActionExecuter, TransferAsyncAction, TransferCommitActionExecuter, TransferOneNodeActionExecuter, TransferTreeActionExecuter, TransferTreeWithCancelActionExecuter, TransformActionExecuter, TransitionSimpleWorkflowActionExecuter, UnlinkRules, UpdateTagScopesActionExecuter, UpdateThumbnailActionExecuter, XSLTRenderingEngine
@AlfrescoPublicApi public interface ActionExecuter
Action executer interface
Author:
Roy Wetherall

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PARAM_RESULT
    Standard action result parameter name

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute(Action action, NodeRef actionedUponNodeRef)
    Execute the action executer
    ActionDefinition
    getActionDefinition()
    Get the action definition for the action
    boolean
    getIgnoreLock()
    Indicates whether a lock on the actioned upon node reference should be ignored or not.
    String
    getQueueName()
    Get the queueName that will execute this action
    boolean
    getTrackStatus()
    Get whether the basic action definition supports action tracking or not.
    default boolean
    isExecuteAsynchronously(NodeRef actionedUponNodeRef)
    Allows ActionExecuters to say that they should be run asynchronously even if requested to run synchronously.
    default void
    verifyActionAccessRestrictions(Action action)
    Verify action access restrictions

  • Field Details

  • Method Details

    • getQueueName

      String getQueueName()
      Get the queueName that will execute this action

    • getIgnoreLock

      boolean getIgnoreLock()
      Indicates whether a lock on the actioned upon node reference should be ignored or not. If true any lock is ignored and execution continues reguardless, otherwise the lock is checked and the action is not executed (ignored) if the actioned upon node reference is locked in any way. By default locks will be ignored.
      Returns:
      boolean true if ignore lock, false otherwise.
      Since:
      3.3.4

    • getTrackStatus

      boolean getTrackStatus()
      Get whether the basic action definition supports action tracking or not. This can be overridden for each action but if not, this value is used. Defaults to false.
      Returns:
      true to track action execution status or false (default) to do no action tracking
      Since:
      3.4.1

    • getActionDefinition

      ActionDefinition getActionDefinition()
      Get the action definition for the action
      Returns:
      the action definition

    • verifyActionAccessRestrictions

      default void verifyActionAccessRestrictions(Action action)
      Verify action access restrictions
      Parameters:
      action -

    • execute

      void execute(Action action, NodeRef actionedUponNodeRef)
      Execute the action executer
      Parameters:
      action - the action
      actionedUponNodeRef - the actioned upon node reference

    • isExecuteAsynchronously

      default boolean isExecuteAsynchronously(NodeRef actionedUponNodeRef)
      Allows ActionExecuters to say that they should be run asynchronously even if requested to run synchronously.
      Parameters:
      actionedUponNodeRef - to processed
      Returns:
      false by default. true to override the executeAsychronously parameter in ActionService.executeAction(Action, NodeRef, boolean, boolean).