Package com.day.cq.workflow.exec

Interface Workflow

All Superinterfaces:

HasMetaData

public interface Workflow
extends HasMetaData

A Workflow represents the current state of an instance of a WorkflowModel. In terms of petri nets the state of a workflow instance can be considered as the collections of tokens (or WorkItems) that flow through the workflow instance.

Method Summary

Modifier and Type	Method	Description
String	getId()	Returns the Workflow instance ID.
String	getInitiator()	Returns the initiator of the Workflow instance.
String	getState()	Returns the workflows state.
Date	getTimeEnded()	Getter for the point in time where the Workflow was finished.
Date	getTimeStarted()	Getter for the point in time where the Workflow instance was started.
WorkflowData	getWorkflowData()	Returns the WorkflowData object assigned to the Workflow instance.
WorkflowModel	getWorkflowModel()	Returns the WorkflowModel that defines the underlying workflow model of the Workflow instance.
List<WorkItem>	getWorkItems()	Returns the list of WorkItems assigned to the Workflow instance.
List<WorkItem>	getWorkItems(WorkItemFilter filter)	Returns a filtered list of WorkItems assigned to the Workflow instance.
boolean	isActive()	Indicates if the Workflow instance is still active.

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

getMetaData, getMetaDataMap

Method Detail

getId

String getId()

Returns the Workflow instance ID.

Returns:

The Workflow instance ID.

getWorkItems

List<WorkItem> getWorkItems()

Returns the list of WorkItems assigned to the Workflow instance.

Returns:

The list of WorkItems assigned to the Workflow

getWorkItems

List<WorkItem> getWorkItems(WorkItemFilter filter)

Returns a filtered list of WorkItems assigned to the Workflow instance.

Parameters:

filter - One is able to filter a subset of the available WorkItems by passing a WorkItemFilter impl.

Returns:

The list of WorkItems assigned to the Workflow

Since:

5.4

getWorkflowModel

WorkflowModel getWorkflowModel()

Returns the WorkflowModel that defines the underlying workflow model of the Workflow instance.

Returns:

The WorkflowModel of the Workflow.

isActive

boolean isActive()

Indicates if the Workflow instance is still active.

Returns:

True if active, otherwise false.

getState

String getState()

Returns the workflows state. In the default implementation this could be one of RUNNING, SUSPENDED, COMPLETED or ABORTED.

Returns:

The current workflows state.

getInitiator

String getInitiator()

Returns the initiator of the Workflow instance.

Returns:

The user who initiated the Workflow.

getTimeStarted

Date getTimeStarted()

Getter for the point in time where the Workflow instance was started.

Returns:

The start time of the Workflow instance.

getTimeEnded

Date getTimeEnded()

Getter for the point in time where the Workflow was finished.

Returns:

The end time of the Workflow instance.

getWorkflowData

WorkflowData getWorkflowData()

Returns the WorkflowData object assigned to the Workflow instance.

Returns:

The WorkflowData object assigned to the Workflow instance.