Package com.adobe.granite.workflow.event

Class WorkflowEvent

java.lang.Object

org.osgi.service.event.Event

com.adobe.granite.workflow.event.WorkflowEvent

public class WorkflowEvent
extends Event

WorkflowEvent provides an extension of Event that is used for propagating workflow related information as OSGI events.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DELEGATEE	Delegate name
static java.lang.String	EVENT_TOPIC	The job topic for adding an entry to the audit log.
static java.lang.String	EVENT_TYPE	The type of the event.
static java.lang.String	FROM_NODE_NAME	The WorkflowNode that is the source of a NODE_TRANSITION_EVENT.
static java.lang.String	JOB_FAILED_EVENT
static java.lang.String	MODEL_DELETED_EVENT
static java.lang.String	MODEL_DEPLOYED_EVENT
static java.lang.String	NODE_TRANSITION_EVENT
static java.lang.String	PARENT_WORKFLOW_ID	ID of the parent Workflow of the Workflow instance the event relates to.
static java.lang.String	PROCESS_TIMEOUT_EVENT
static java.lang.String	RESOURCE_COLLECTION_MODIFIED
static java.lang.String	RETURNED_TO	The name of the user to whom the workItem is returned
static java.lang.String	TIME_STAMP	Time stamp of the time the event was created.
static java.lang.String	TO_NODE_NAME	The WorkflowNode that is the target of a NODE_TRANSITION_EVENT.
static java.lang.String	USER	The user whose that has triggered the event.
static java.lang.String	VARIABLE_NAME	The name of the variable that has changed when a VARIABLE_UPDATE_EVENT is triggered.
static java.lang.String	VARIABLE_UPDATE_EVENT
static java.lang.String	VARIABLE_VALUE	The new value of the variable that has changed when a VARIABLE_UPDATE_EVENT is triggered.
static java.lang.String	WORK_DATA	The WorkflowData that relates to the event.
static java.lang.String	WORK_ITEM	The WorkItem that relates to the event.
static java.lang.String	WORKFLOW_ABORTED_EVENT
static java.lang.String	WORKFLOW_COMPLETED_EVENT
static java.lang.String	WORKFLOW_INSTANCE_ID	The ID of the Workflow instance the event relates to.
static java.lang.String	WORKFLOW_NAME	The name of the WorkflowModel the event relates to.
static java.lang.String	WORKFLOW_NODE	The node of the WorkflowModel the event relates to.
static java.lang.String	WORKFLOW_RESUMED_EVENT
static java.lang.String	WORKFLOW_STARTED_EVENT
static java.lang.String	WORKFLOW_SUSPENDED_EVENT
static java.lang.String	WORKFLOW_VERSION	The version of the WorkflowModel the event relates to.
static java.lang.String	WORKITEM_CLAIM_EVENT
static java.lang.String	WORKITEM_DELEGATION_EVENT
static java.lang.String	WORKITEM_UNCLAIM_EVENT

Constructor Summary

Constructors

Constructor	Description
WorkflowEvent(java.util.Dictionary<?,?> props)	Default constructor used for creating WorkflowEvent instances.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDelegateName()	Delegate name
java.lang.String	getEventType()	The type of the event.
java.lang.String	getFromNodeName()	The WorkflowNode that is the source of a NODE_TRANSITION_EVENT.
java.lang.String	getParentWorkflowId()	ID of the parent Workflow of the Workflow instance the event relates to.
java.lang.String	getReturnedToName()	Returns the name of the user to whom the workItem is returned
java.util.Date	getTimeStamp()	Time stamp of the time the event was created.
java.lang.String	getToNodeName()	The WorkflowNode that is the target of a NODE_TRANSITION_EVENT.
java.lang.String	getUser()	The user who triggered the event.
java.lang.String	getVariableName()	The name of the variable that has changed when a VARIABLE_UPDATE_EVENT is triggered.
java.lang.Object	getVariableValue()	The new value of the variable that has changed when a VARIABLE_UPDATE_EVENT is triggered.
WorkflowData	getWorkflowData()	The WorkflowData that relates to the event.
java.lang.String	getWorkflowInstanceId()	The ID of the Workflow instance the event relates to.
java.lang.String	getWorkflowName()	The name of the WorkflowModel the event relates to.
java.lang.String	getWorkflowNode()	The node of the WorkflowModel the event relates to.
java.lang.String	getWorkflowVersion()	The version of the WorkflowModel the event relates to.
WorkItem	getWorkItem()	The WorkItem that relates to the event.

Methods inherited from class org.osgi.service.event.Event

containsProperty, equals, getProperty, getPropertyNames, getTopic, hashCode, matches, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

EVENT_TOPIC

public static final java.lang.String EVENT_TOPIC

The job topic for adding an entry to the audit log.

See Also:

Constant Field Values

TIME_STAMP

public static final java.lang.String TIME_STAMP

Time stamp of the time the event was created.

See Also:

Constant Field Values

USER

public static final java.lang.String USER

The user whose that has triggered the event.

See Also:

Constant Field Values

WORKFLOW_NAME

public static final java.lang.String WORKFLOW_NAME

The name of the WorkflowModel the event relates to.

See Also:

Constant Field Values

WORKFLOW_VERSION

public static final java.lang.String WORKFLOW_VERSION

The version of the WorkflowModel the event relates to.

See Also:

Constant Field Values

WORKFLOW_NODE

public static final java.lang.String WORKFLOW_NODE

The node of the WorkflowModel the event relates to.

See Also:

Constant Field Values

WORKFLOW_INSTANCE_ID

public static final java.lang.String WORKFLOW_INSTANCE_ID

The ID of the Workflow instance the event relates to.

See Also:

Constant Field Values

PARENT_WORKFLOW_ID

public static final java.lang.String PARENT_WORKFLOW_ID

ID of the parent Workflow of the Workflow instance the event relates to.

See Also:

Constant Field Values

WORK_DATA

public static final java.lang.String WORK_DATA

The WorkflowData that relates to the event.

See Also:

Constant Field Values

WORK_ITEM

public static final java.lang.String WORK_ITEM

The WorkItem that relates to the event.

See Also:

Constant Field Values

FROM_NODE_NAME

public static final java.lang.String FROM_NODE_NAME

The WorkflowNode that is the source of a NODE_TRANSITION_EVENT.

See Also:

Constant Field Values

TO_NODE_NAME

public static final java.lang.String TO_NODE_NAME

The WorkflowNode that is the target of a NODE_TRANSITION_EVENT.

See Also:

Constant Field Values

VARIABLE_NAME

public static final java.lang.String VARIABLE_NAME

The name of the variable that has changed when a VARIABLE_UPDATE_EVENT is triggered.

See Also:

Constant Field Values

VARIABLE_VALUE

public static final java.lang.String VARIABLE_VALUE

The new value of the variable that has changed when a VARIABLE_UPDATE_EVENT is triggered.

See Also:

Constant Field Values

DELEGATEE

public static final java.lang.String DELEGATEE

Delegate name

See Also:

Constant Field Values

RETURNED_TO

public static final java.lang.String RETURNED_TO

The name of the user to whom the workItem is returned

See Also:

Constant Field Values

EVENT_TYPE

public static final java.lang.String EVENT_TYPE

The type of the event. Can be one of

• MODEL_DEPLOYED_EVENT
• WORKFLOW_STARTED_EVENT
• WORKFLOW_ABORTED_EVENT
• WORKFLOW_SUSPENDED_EVENT
• WORKFLOW_RESUMED_EVENT
• WORKFLOW_COMPLETED_EVENT
• NODE_TRANSITION_EVENT
• VARIABLE_UPDATE_EVENT
• PROCESS_TIMEOUT_EVENT
• WORKITEM_DELEGATION_EVENT

See Also:

Constant Field Values

MODEL_DEPLOYED_EVENT

public static final java.lang.String MODEL_DEPLOYED_EVENT

See Also:

Constant Field Values

MODEL_DELETED_EVENT

public static final java.lang.String MODEL_DELETED_EVENT

See Also:

Constant Field Values

WORKFLOW_STARTED_EVENT

public static final java.lang.String WORKFLOW_STARTED_EVENT

See Also:

Constant Field Values

WORKFLOW_ABORTED_EVENT

public static final java.lang.String WORKFLOW_ABORTED_EVENT

See Also:

Constant Field Values

WORKFLOW_SUSPENDED_EVENT

public static final java.lang.String WORKFLOW_SUSPENDED_EVENT

See Also:

Constant Field Values

WORKFLOW_RESUMED_EVENT

public static final java.lang.String WORKFLOW_RESUMED_EVENT

See Also:

Constant Field Values

WORKFLOW_COMPLETED_EVENT

public static final java.lang.String WORKFLOW_COMPLETED_EVENT

See Also:

Constant Field Values

NODE_TRANSITION_EVENT

public static final java.lang.String NODE_TRANSITION_EVENT

See Also:

Constant Field Values

VARIABLE_UPDATE_EVENT

public static final java.lang.String VARIABLE_UPDATE_EVENT

See Also:

Constant Field Values

PROCESS_TIMEOUT_EVENT

public static final java.lang.String PROCESS_TIMEOUT_EVENT

See Also:

Constant Field Values

WORKITEM_DELEGATION_EVENT

public static final java.lang.String WORKITEM_DELEGATION_EVENT

See Also:

Constant Field Values

WORKITEM_UNCLAIM_EVENT

public static final java.lang.String WORKITEM_UNCLAIM_EVENT

See Also:

Constant Field Values

WORKITEM_CLAIM_EVENT

public static final java.lang.String WORKITEM_CLAIM_EVENT

See Also:

Constant Field Values

JOB_FAILED_EVENT

public static final java.lang.String JOB_FAILED_EVENT

See Also:

Constant Field Values

RESOURCE_COLLECTION_MODIFIED

public static final java.lang.String RESOURCE_COLLECTION_MODIFIED

See Also:

Constant Field Values

Constructor Detail

WorkflowEvent

public WorkflowEvent(java.util.Dictionary<?,?> props)

Default constructor used for creating WorkflowEvent instances.

Parameters:

props - The properties assigned to the event.

Method Detail

getTimeStamp

public java.util.Date getTimeStamp()

Time stamp of the time the event was created.

Returns:

the time stamp of the time the event was created

getUser

public java.lang.String getUser()

The user who triggered the event.

Returns:

the user who triggered the event

getWorkflowName

public java.lang.String getWorkflowName()

The name of the WorkflowModel the event relates to.

Returns:

the name of the WorkflowModel the event relates to

getWorkflowVersion

public java.lang.String getWorkflowVersion()

The version of the WorkflowModel the event relates to.

Returns:

the version of the WorkflowModel the event relates to

getWorkflowNode

public java.lang.String getWorkflowNode()

The node of the WorkflowModel the event relates to.

Returns:

the node of the WorkflowModel the event relates to

getWorkflowInstanceId

public java.lang.String getWorkflowInstanceId()

The ID of the Workflow instance the event relates to.

Returns:

the ID of the Workflow instance the event relates to

getParentWorkflowId

public java.lang.String getParentWorkflowId()

ID of the parent Workflow of the Workflow instance the event relates to.

Returns:

the ID of the parent Workflow of the Workflow instance the event relates to

getWorkflowData

public WorkflowData getWorkflowData()

The WorkflowData that relates to the event.

Returns:

the WorkflowData that relates to the event

getWorkItem

public WorkItem getWorkItem()

The WorkItem that relates to the event.

Returns:

the WorkItem that relates to the event

getFromNodeName

public java.lang.String getFromNodeName()

The WorkflowNode that is the source of a NODE_TRANSITION_EVENT.

Returns:

the WorkflowNode that is the source of a NODE_TRANSITION_EVENT

getToNodeName

public java.lang.String getToNodeName()

The WorkflowNode that is the target of a NODE_TRANSITION_EVENT.

Returns:

the WorkflowNode that is the target of a NODE_TRANSITION_EVENT

getVariableName

public java.lang.String getVariableName()

The name of the variable that has changed when a VARIABLE_UPDATE_EVENT is triggered.

Returns:

the name of the variable that has changed when a VARIABLE_UPDATE_EVENT is triggered

getVariableValue

public java.lang.Object getVariableValue()

The new value of the variable that has changed when a VARIABLE_UPDATE_EVENT is triggered.

Returns:

the new value of the variable that has changed when a VARIABLE_UPDATE_EVENT is triggered

getDelegateName

public java.lang.String getDelegateName()

Delegate name

Returns:

the delegate name

getReturnedToName

public java.lang.String getReturnedToName()

Returns the name of the user to whom the workItem is returned

Returns:

user name of the user to whom the workitem is returned.

getEventType

public java.lang.String getEventType()

The type of the event. Can be one of

• MODEL_DEPLOYED_EVENT
• WORKFLOW_STARTED_EVENT
• WORKFLOW_ABORTED_EVENT
• WORKFLOW_SUSPENDED_EVENT
• WORKFLOW_RESUMED_EVENT
• WORKFLOW_COMPLETED_EVENT
• NODE_TRANSITION_EVENT
• VARIABLE_UPDATE_EVENT
• PROCESS_TIMEOUT_EVENT
• WORKITEM_DELEGATION_EVENT

Returns:

the event type