Package com.adobe.granite.workflow.exec

Interface WorkItem

All Superinterfaces:

HasMetaData, InboxItem

@ProviderType
public interface WorkItem
extends InboxItem, 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.

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.granite.workflow.exec.InboxItem

InboxItem.Priority

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCurrentAssignee()	Returns the currently assigned user, 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.
void	setDueTime(java.util.Date dueTime)	Sets the due time of this workitem.
void	setPriority(InboxItem.Priority priority)	Sets the priority for this workitem.
void	setProgressBeginTime(java.util.Date progressBeginTime)	Sets the progress begin time for this workitem.

Methods inherited from interface com.adobe.granite.workflow.HasMetaData

getMetaDataMap

Methods inherited from interface com.adobe.granite.workflow.exec.InboxItem

getContentPath, getDueTime, getItemSubType, getItemType, getPriority, getProgressBeginTime, getStatus

Method Detail

getTimeStarted

java.util.Date getTimeStarted()

Returns the start time of the WorkflowItem.

Specified by:

getTimeStarted in interface InboxItem

Returns:

The start time of the WorkflowItem.

getTimeEnded

java.util.Date getTimeEnded()

Returns the end time of the WorkflowItem.

Specified by:

getTimeEnded in interface InboxItem

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.

Specified by:

getId in interface InboxItem

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 currently assigned user, respectively the info in which inbox the WorkItem "resides".

Specified by:

getCurrentAssignee in interface InboxItem

Returns:

current assignee

setDueTime

void setDueTime(java.util.Date dueTime)

Sets the due time of this workitem.

Parameters:

dueTime - the new due time of this workitem

setProgressBeginTime

void setProgressBeginTime(java.util.Date progressBeginTime)

Sets the progress begin time for this workitem.

Parameters:

progressBeginTime - the time for when progress should start on this workitem.

setPriority

void setPriority(InboxItem.Priority priority)

Sets the priority for this workitem.

Parameters:

priority - the priority of this task.

See Also:

for details