com.day.cq.workflow.exec

Interface WorkItem

All Superinterfaces:

HasMetaData

public interface WorkItem
extends HasMetaData

A WorkItem is the unit that is passed through an Workflow instance of a WorkflowModel. It contains the WorkflowData the instances acts on and a reference to the WorkflowNode that describes the underlying workflow step. A WorkItem can be considered as a token in a petri net that flows through the net during execution.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrentAssignee() Returns the current assignee, respectively the info in which inbox the workitem "resides".
java.lang.String	getId() Returns the ID of the WorkflowItem.
WorkflowNode	getNode() Returns the current WorkflowNode the WorkflowItem is attached to.
java.util.Date	getTimeEnded() Returns the end time of the WorkflowItem.
java.util.Date	getTimeStarted() Returns the start time of the WorkflowItem.
Workflow	getWorkflow() Returns the Workflow instance assigned with this WorkflowItem.
WorkflowData	getWorkflowData() Returns the WorkflowData assigned to the WorkflowItem.

Methods inherited from interface com.day.cq.workflow.HasMetaData

getMetaData, getMetaDataMap

Method Detail

getTimeStarted

java.util.Date getTimeStarted()

Returns the start time of the WorkflowItem.

Returns:

The start time of the WorkflowItem.

getTimeEnded

java.util.Date getTimeEnded()

Returns the end time of the WorkflowItem.

Returns:

The end time of the WorkflowItem.

getWorkflow

Workflow getWorkflow()

Returns the Workflow instance assigned with this WorkflowItem.

Returns:

Workflow of the workflow instance assigned with the WorkflowItem.

getNode

WorkflowNode getNode()

Returns the current WorkflowNode the WorkflowItem is attached to.

Returns:

The current WorkflowNode of the WorkflowItem.

getId

java.lang.String getId()

Returns the ID of the WorkflowItem.

Returns:

ID of the WorkflowItem.

getWorkflowData

WorkflowData getWorkflowData()

Returns the WorkflowData assigned to the WorkflowItem.

Returns:

the WorkflowData of the WorkflowItem.

getCurrentAssignee

java.lang.String getCurrentAssignee()

Returns the current assignee, respectively the info in which inbox the workitem "resides".

Returns:

current assignee