Package org.camunda.bpm.engine.runtime

Enum Class MessageCorrelationResultType

java.lang.Object

java.lang.Enum<MessageCorrelationResultType>

org.camunda.bpm.engine.runtime.MessageCorrelationResultType

All Implemented Interfaces:

Serializable, Comparable<MessageCorrelationResultType>, Constable

public enum MessageCorrelationResultType
extends Enum<MessageCorrelationResultType>

The message correlation result type indicates which type of message correlation result is returned after a message correlation. A message may be correlated to either a waiting execution (BPMN receive message event) or a process definition (BPMN message start event). The result type indicates which correlation was performed.

Author:

Christopher Zell <christopher.zell@camunda.com>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Execution	signifies a message correlated to an execution
ProcessDefinition	signifies a message correlated to a process definition

Method Summary

Modifier and Type	Method	Description
static MessageCorrelationResultType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageCorrelationResultType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Execution

public static final MessageCorrelationResultType Execution

signifies a message correlated to an execution

ProcessDefinition

public static final MessageCorrelationResultType ProcessDefinition

signifies a message correlated to a process definition

Method Details

values

public static MessageCorrelationResultType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MessageCorrelationResultType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null