org.camunda.bpm.engine.runtime
Enum MessageCorrelationResultType

java.lang.Object
  java.lang.Enum<MessageCorrelationResultType>
      org.camunda.bpm.engine.runtime.MessageCorrelationResultType

All Implemented Interfaces:

Serializable, Comparable<MessageCorrelationResultType>

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

Enum Constant Summary

Execution
signifies a message correlated to an execution

ProcessDefinition
signifies a message correlated to a process definition

Method Summary

static MessageCorrelationResultType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageCorrelationResultType[]	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

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 Detail

values

public static MessageCorrelationResultType[] 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 (MessageCorrelationResultType c : MessageCorrelationResultType.values())
    System.out.println(c);

Returns:

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

valueOf

public static MessageCorrelationResultType 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