com.day.cq.workflow.impl.exec
Class CQWorkflow

java.lang.Object
  com.day.cq.workflow.impl.exec.CQWorkflow

All Implemented Interfaces:

Workflow, HasMetaData, Serializable

public class CQWorkflow
extends Object
implements Workflow, Serializable

The CQWorkflow class implements the Workflow interface.

See Also:

Serialized Form

Field Summary

static String	START_COMMENT Meta data key for a comment that can be added when starting a Workflow.
static String	STATE_ABORTED
static String	STATE_COMPLETED
static String	STATE_RUNNING
static String	STATE_SUSPENDED
static String	TERMINATE_COMMENT Meta data key for a comment that can be added when a Workflow is terminated.

Constructor Summary

CQWorkflow()

Method Summary

String	getId() Returns the Workflow instance ID.
String	getInitiator() Returns the initiator of the Workflow instance.
Dictionary<String,String>	getMetaData() Provides meta data assigned to the entity.
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.
boolean	isActive() Indicates if the Workflow instance is still active.
void	setId(String id)
void	setInitiator(String initiator)
void	setModel(CQWorkflowModel model)
void	setState(String state)
void	setTimeEnded(Date time)
void	setTimeStarted(Date time)
void	setWorkflowData(CQWorkflowData workflowData)
void	setWorkItems(List<WorkItem> workItems)

Methods inherited from class java.lang.Object

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

Field Detail

START_COMMENT

public static final String START_COMMENT

Meta data key for a comment that can be added when starting a Workflow.

See Also:

Constant Field Values

TERMINATE_COMMENT

public static final String TERMINATE_COMMENT

Meta data key for a comment that can be added when a Workflow is terminated.

See Also:

Constant Field Values

STATE_RUNNING

public static final String STATE_RUNNING

See Also:

Constant Field Values

STATE_COMPLETED

public static final String STATE_COMPLETED

See Also:

Constant Field Values

STATE_SUSPENDED

public static final String STATE_SUSPENDED

See Also:

Constant Field Values

STATE_ABORTED

public static final String STATE_ABORTED

See Also:

Constant Field Values

Constructor Detail

CQWorkflow

public CQWorkflow()

Method Detail

getWorkItems

public List<WorkItem> getWorkItems()

Description copied from interface: Workflow

Returns the list of WorkItems assigned to the Workflow instance.

Specified by:

getWorkItems in interface Workflow

Returns:

The list of WorkItems assigned to the Workflow

getWorkflowModel

public WorkflowModel getWorkflowModel()

Description copied from interface: Workflow

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

Specified by:

getWorkflowModel in interface Workflow

Returns:

The WorkflowModel of the Workflow.

isActive

public boolean isActive()

Description copied from interface: Workflow

Indicates if the Workflow instance is still active.

Specified by:

isActive in interface Workflow

Returns:

True if active, otherwise false.

getState

public String getState()

Description copied from interface: Workflow

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

Specified by:

getState in interface Workflow

Returns:

The current workflows state.

getInitiator

public String getInitiator()

Description copied from interface: Workflow

Returns the initiator of the Workflow instance.

Specified by:

getInitiator in interface Workflow

Returns:

The user who initiated the Workflow.

getTimeStarted

public Date getTimeStarted()

Description copied from interface: Workflow

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

Specified by:

getTimeStarted in interface Workflow

Returns:

The start time of the Workflow instance.

getTimeEnded

public Date getTimeEnded()

Description copied from interface: Workflow

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

Specified by:

getTimeEnded in interface Workflow

Returns:

The end time of the Workflow instance.

getId

public String getId()

Description copied from interface: Workflow

Returns the Workflow instance ID.

Specified by:

getId in interface Workflow

Returns:

The Workflow instance ID.

getWorkflowData

public WorkflowData getWorkflowData()

Description copied from interface: Workflow

Returns the WorkflowData object assigned to the Workflow instance.

Specified by:

getWorkflowData in interface Workflow

Returns:

The WorkflowData object assigned to the Workflow instance.

getMetaData

public Dictionary<String,String> getMetaData()

Description copied from interface: HasMetaData

Provides meta data assigned to the entity.

Specified by:

getMetaData in interface HasMetaData

Returns:

The map of meta data assigned to the entity.

setState

public void setState(String state)

setInitiator

public void setInitiator(String initiator)

setModel

public void setModel(CQWorkflowModel model)

setId

public void setId(String id)

setTimeStarted

public void setTimeStarted(Date time)

setTimeEnded

public void setTimeEnded(Date time)

setWorkItems

public void setWorkItems(List<WorkItem> workItems)

setWorkflowData

public void setWorkflowData(CQWorkflowData workflowData)