org.camunda.bpm.engine.impl.runtime
Class MessageCorrelationResult

java.lang.Object
  org.camunda.bpm.engine.impl.runtime.MessageCorrelationResult

public class MessageCorrelationResult
extends Object

The result of 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 type of the correlation (execution vs. processDefinition) can be obtained using getResultType()

Correlation is performed by a CorrelationHandler.

Author:

Daniel Meyer

Field Summary

protected ExecutionEntity	executionEntity
protected ProcessDefinitionEntity	processDefinitionEntity
protected String	resultType
protected String	startEventActivityId
static String	TYPE_EXECUTION signifies a message correlated to an execution
static String	TYPE_PROCESS_DEFINITION signifies a message correlated to a process definition

Constructor Summary

MessageCorrelationResult()

Method Summary

ExecutionEntity	getExecutionEntity()
ProcessDefinitionEntity	getProcessDefinitionEntity()
String	getResultType()
String	getStartEventActivityId()
static MessageCorrelationResult	matchedExecution(ExecutionEntity executionEntity)
static MessageCorrelationResult	matchedProcessDefinition(ProcessDefinitionEntity processDefinitionEntity, String startEventActivityId)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_EXECUTION

public static final String TYPE_EXECUTION

signifies a message correlated to an execution

See Also:

Constant Field Values

TYPE_PROCESS_DEFINITION

public static final String TYPE_PROCESS_DEFINITION

signifies a message correlated to a process definition

See Also:

Constant Field Values

resultType

protected String resultType

See Also:

TYPE_EXECUTION, TYPE_PROCESS_DEFINITION

executionEntity

protected ExecutionEntity executionEntity

processDefinitionEntity

protected ProcessDefinitionEntity processDefinitionEntity

startEventActivityId

protected String startEventActivityId

Constructor Detail

MessageCorrelationResult

public MessageCorrelationResult()

Method Detail

matchedExecution

public static MessageCorrelationResult matchedExecution(ExecutionEntity executionEntity)

matchedProcessDefinition

public static MessageCorrelationResult matchedProcessDefinition(ProcessDefinitionEntity processDefinitionEntity,
                                                                String startEventActivityId)

getExecutionEntity

public ExecutionEntity getExecutionEntity()

getProcessDefinitionEntity

public ProcessDefinitionEntity getProcessDefinitionEntity()

getStartEventActivityId

public String getStartEventActivityId()

getResultType

public String getResultType()