org.alfresco.service.cmr.action

Interface CancellableAction

All Superinterfaces:

Action, ParameterizedItem

All Known Subinterfaces:

ReplicationDefinition

All Known Implementing Classes:

ReplicationDefinitionImpl

public interface CancellableAction
extends Action

A marker interface that forms part of the Cancel Action contract. An action that implements this interface commits to periodically asking the ActionTrackingService if a cancel of it has been requested, and orderly terminating itself if so. Actions implementing this should, via their ActionExecuter, periodically call ActionTrackingService.isCancellationRequested(CancellableAction) to check if a cancel has been requested for them. If it has, they should tidy up as much as possible, and then throw a ActionCancelledException to indicate to the ActionService that they ceased running due to a cancel.

Author:

Nick Burch

Method Summary

Methods inherited from interface org.alfresco.service.cmr.action.Action

addActionCondition, addActionCondition, addParameterValues, getActionCondition, getActionConditions, getActionDefinitionName, getCompensatingAction, getCreatedDate, getCreator, getDescription, getExecuteAsychronously, getExecutionEndDate, getExecutionFailureMessage, getExecutionStartDate, getExecutionStatus, getModifiedDate, getModifier, getNodeRef, getTitle, getTrackStatus, hasActionConditions, indexOfActionCondition, removeActionCondition, removeAllActionConditions, setActionCondition, setCompensatingAction, setDescription, setExecuteAsynchronously, setTitle, setTrackStatus

Methods inherited from interface org.alfresco.service.cmr.action.ParameterizedItem

getId, getParameterValue, getParameterValues, setParameterValue, setParameterValues