Files
alfresco-community-repo/source/java/org/alfresco/service/cmr/action/CancellableAction.java
Raluca Munteanu 8674e2bfc8 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125603 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125484 slanglois: MNT-16155 Update source headers - remove old Copyrights from Java and JSP dource files


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125781 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 12:48:49 +00:00

26 lines
965 B
Java

package org.alfresco.service.cmr.action;
import org.alfresco.repo.action.ActionCancelledException;
import org.alfresco.repo.action.executer.ActionExecuter;
/**
* A marker interface that forms part of the Cancel Action contract.
* An action that implements this interface commits to periodically
* asking the {@link ActionTrackingService} if a cancel of it has
* been requested, and orderly terminating itself if so.
*
* Actions implementing this should, via their
* {@link ActionExecuter}, periodically call
* {@link 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 {@link ActionCancelledException} to indicate to the
* {@link ActionService} that they ceased running due to a
* cancel.
*
* @author Nick Burch
*/
public interface CancellableAction extends Action
{
}