org.camunda.bpm.extension.osgi.eventing.impl

Enum BusinessProcessEventPropertiesFiller

java.lang.Object

java.lang.Enum<BusinessProcessEventPropertiesFiller>

org.camunda.bpm.extension.osgi.eventing.impl.BusinessProcessEventPropertiesFiller

All Implemented Interfaces:

Serializable, Comparable<BusinessProcessEventPropertiesFiller>

public enum BusinessProcessEventPropertiesFiller
extends Enum<BusinessProcessEventPropertiesFiller>

This enum defines all the possible properties that can be placed inside the dictionary of a event.

Author:

Ronny Bräunlich

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVITY_ID the id of the activity the process is currently in / was in at the moment the event was fired.
EXECUTION_ID the id of the org.camunda.bpm.engine.runtime.Execution this event corresponds to
PROCESS_DEFINITION the id of the process definition in which the event is happening / has happened or null the event was not related to a process definition
PROCESS_INSTANCE_ID the id of the org.camunda.bpm.engine.runtime.ProcessInstance this event corresponds to
TASK_DEFINITION_KEY the id of the task in the process definition (BPMN XML) or null if this is not a task event.
TASK_ID the task id of the current task or null if this is not a task event.
TIMESTAMP the timestamp indicating the local time at which the event was fired.
TRANSITION_ID the id of the transition being taken / that was taken
TYPE the type of the event, one of the constants in TaskListener or ExecutionListener

Method Summary

Methods

Modifier and Type	Method and Description
static void	fillDictionary(Dictionary<String,String> dictionary, org.camunda.bpm.engine.delegate.DelegateExecution execution)
static void	fillDictionary(Dictionary<String,String> dictionary, org.camunda.bpm.engine.delegate.DelegateTask task)
String	getPropertyKey()
static BusinessProcessEventPropertiesFiller	valueOf(String name) Returns the enum constant of this type with the specified name.
static BusinessProcessEventPropertiesFiller[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PROCESS_DEFINITION

public static final BusinessProcessEventPropertiesFiller PROCESS_DEFINITION

the id of the process definition in which the event is happening / has happened or null the event was not related to a process definition

ACTIVITY_ID

public static final BusinessProcessEventPropertiesFiller ACTIVITY_ID

the id of the activity the process is currently in / was in at the moment the event was fired.

TRANSITION_ID

public static final BusinessProcessEventPropertiesFiller TRANSITION_ID

the id of the transition being taken / that was taken

PROCESS_INSTANCE_ID

public static final BusinessProcessEventPropertiesFiller PROCESS_INSTANCE_ID

the id of the org.camunda.bpm.engine.runtime.ProcessInstance this event corresponds to

EXECUTION_ID

public static final BusinessProcessEventPropertiesFiller EXECUTION_ID

the id of the org.camunda.bpm.engine.runtime.Execution this event corresponds to

TYPE

public static final BusinessProcessEventPropertiesFiller TYPE

the type of the event, one of the constants in TaskListener or ExecutionListener

TIMESTAMP

public static final BusinessProcessEventPropertiesFiller TIMESTAMP

the timestamp indicating the local time at which the event was fired.

TASK_ID

public static final BusinessProcessEventPropertiesFiller TASK_ID

the task id of the current task or null if this is not a task event.

TASK_DEFINITION_KEY

public static final BusinessProcessEventPropertiesFiller TASK_DEFINITION_KEY

the id of the task in the process definition (BPMN XML) or null if this is not a task event.

Method Detail

values

public static BusinessProcessEventPropertiesFiller[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BusinessProcessEventPropertiesFiller c : BusinessProcessEventPropertiesFiller.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BusinessProcessEventPropertiesFiller valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getPropertyKey

public String getPropertyKey()

fillDictionary

public static void fillDictionary(Dictionary<String,String> dictionary,
                  org.camunda.bpm.engine.delegate.DelegateExecution execution)

fillDictionary

public static void fillDictionary(Dictionary<String,String> dictionary,
                  org.camunda.bpm.engine.delegate.DelegateTask task)