org.alfresco.repo.action.executer
Interface ActionExecuter

All Known Implementing Classes:
AbstractRenderingEngine, AbstractTransformationRenderingEngine, ActionExecuterAbstractBase, ActionServiceImplTest.SleepActionExecuter, AddFailedThumbnailActionExecuter, AddFeaturesActionExecuter, AVMDeployWebsiteAction, AVMRevertListAction, AVMRevertStoreAction, AVMRevertToVersionAction, AVMUndoSandboxListAction, BaseTemplateRenderingEngine, BlogAction, CheckInActionExecuter, CheckOutActionExecuter, CompositeActionExecuter, CompositeRenderingEngine, ContentMetadataExtracter, CopyActionExecuter, CopyToWebProjectActionExecuter, CountChildrenActionExecuter, CounterIncrementActionExecuter, CreateThumbnailActionExecuter, CreateTransferTargetActionExecuter, CreateVersionActionExecuter, DeleteRenditionActionExecuter, ExecuteAllRulesActionExecuter, ExporterActionExecuter, FreemarkerRenderingEngine, HTMLRenderingEngine, ImageRenderingEngine, ImageTransformActionExecuter, ImporterActionExecuter, LinkCategoryActionExecuter, LinkRules, MailActionExecuter, MoveActionExecuter, PerformRenditionActionExecuter, PublishEventAction, ReformatRenderingEngine, RefreshTagScopeActionExecuter, RemoveFeaturesActionExecuter, ReorderRules, ReplicationActionExecutor, RepositoryExporterActionExecuter, ScriptActionExecuter, SetPropertyValueActionExecuter, SimpleAVMPromoteAction, SimpleAVMSubmitAction, SimpleWorkflowActionExecuter, SpecialiseTypeActionExecuter, StartAVMWorkflowAction, StartWorkflowActionExecuter, TikaPoweredContainerExtractor.ExtractorActionExecutor, TransferAsyncAction, TransferCommitActionExecuter, TransferOneNodeActionExecuter, TransferTreeActionExecuter, TransferTreeWithCancelActionExecuter, TransformActionExecuter, TransitionSimpleWorkflowActionExecuter, UnlinkRules, UpdateTagScopesActionExecuter, UpdateThumbnailActionExecuter, WCMSandboxRevertSnapshotAction, WCMSandboxSubmitAction, WCMSandboxUndoAction, XSLTRenderingEngine

public interface ActionExecuter

Action executer interface


Field Summary
static java.lang.String PARAM_RESULT
          Standard action result parameter name
 
Method Summary
 void execute(Action action, org.alfresco.service.cmr.repository.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.
 java.lang.String getQueueName()
          Get the queueName that will execute this action
 boolean getTrackStatus()
          Get whether the basic action definition supports action tracking or not.
 

Field Detail

PARAM_RESULT

static final java.lang.String PARAM_RESULT
Standard action result parameter name

See Also:
Constant Field Values
Method Detail

getQueueName

java.lang.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

execute

void execute(Action action,
             org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
Execute the action executer

Parameters:
action - the action
actionedUponNodeRef - the actioned upon node reference


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.