org.alfresco.service.cmr.action

Class ExecutionDetails

java.lang.Object

org.alfresco.service.cmr.action.ExecutionDetails

All Implemented Interfaces:

Serializable

public class ExecutionDetails
extends Object
implements Serializable

Holds all the details available to the ActionTrackingService on a currently executing Action.

Author:

Nick Burch

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExecutionDetails()
ExecutionDetails(ExecutionSummary executionSummary, org.alfresco.service.cmr.repository.NodeRef persistedActionRef, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef, String runningOn, Date startedAt, boolean cancelRequested)
ExecutionDetails(ExecutionSummary executionSummary, org.alfresco.service.cmr.repository.NodeRef persistedActionRef, String runningOn, Date startedAt, boolean cancelRequested)

Method Summary

Modifier and Type	Method and Description
org.alfresco.service.cmr.repository.NodeRef	getActionedUponNodeRef() Gets the NodeRef the action is acting on.
String	getActionId() What is the id of the action?
String	getActionType() What kind of action is this?
int	getExecutionInstance() Which instance of the action is this? Every time you start an action, it gets a new instance ID, and this lets you tell the difference between two copies running in parallel.
ExecutionSummary	getExecutionSummary()
org.alfresco.service.cmr.repository.NodeRef	getPersistedActionRef() Gets the NodeRef where the action is persisted.
String	getRunningOn()
Date	getStartedAt() Returns when this action started executing, or null if it is still pending
boolean	isCancelRequested()
void	setExecutionSummary(ExecutionSummary executionSummary)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExecutionDetails

public ExecutionDetails()

ExecutionDetails

public ExecutionDetails(ExecutionSummary executionSummary,
                        org.alfresco.service.cmr.repository.NodeRef persistedActionRef,
                        String runningOn,
                        Date startedAt,
                        boolean cancelRequested)

ExecutionDetails

public ExecutionDetails(ExecutionSummary executionSummary,
                        org.alfresco.service.cmr.repository.NodeRef persistedActionRef,
                        org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
                        String runningOn,
                        Date startedAt,
                        boolean cancelRequested)

Method Detail

getExecutionSummary

public ExecutionSummary getExecutionSummary()

setExecutionSummary

public void setExecutionSummary(ExecutionSummary executionSummary)

getActionType

public String getActionType()

What kind of action is this?

Returns:

The action type, typically an executor bean name

getActionId

public String getActionId()

What is the id of the action?

Returns:

The action ID

getExecutionInstance

public int getExecutionInstance()

Which instance of the action is this? Every time you start an action, it gets a new instance ID, and this lets you tell the difference between two copies running in parallel.

Returns:

The instance ID

getPersistedActionRef

public org.alfresco.service.cmr.repository.NodeRef getPersistedActionRef()

Gets the NodeRef where the action is persisted.

Returns:

NodeRef for the persisted action

getActionedUponNodeRef

public org.alfresco.service.cmr.repository.NodeRef getActionedUponNodeRef()

Gets the NodeRef the action is acting on.

Returns:

NodeRef the action is acting on

getRunningOn

public String getRunningOn()

getStartedAt

public Date getStartedAt()

Returns when this action started executing, or null if it is still pending

isCancelRequested

public boolean isCancelRequested()