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, ErrorProneActionExecutor, ExecuteAllRulesActionExecuter, ExporterActionExecuter, FreemarkerRenderingEngine, HTMLRenderingEngine, ImageRenderingEngine, ImageTransformActionExecuter, ImporterActionExecuter, LinkCategoryActionExecuter, LinkRules, MailActionExecuter, MoveActionExecuter, PerformRenditionActionExecuter, QuickShareLinkExpiryActionExecutor, ReformatRenderingEngine, RefreshTagScopeActionExecuter, RemoveFeaturesActionExecuter, ReorderRules, ReplicationActionExecutor, RepositoryExporterActionExecuter, ScriptActionExecuter, SetPropertyValueActionExecuter, SimpleWorkflowActionExecuter, SpecialiseTypeActionExecuter, StartWorkflowActionExecuter, TakeOwnershipActionExecuter, TikaPoweredContainerExtractor.ExtractorActionExecutor, 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 java.lang.String	PARAM_RESULT	Standard action result parameter name

Method Summary

Modifier and Type	Method	Description
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