Package org.camunda.bpm.engine.impl.runtime

Class CorrelationHandlerResult

java.lang.Object

org.camunda.bpm.engine.impl.runtime.CorrelationHandlerResult

public class CorrelationHandlerResult
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

Fields

Modifier and Type	Field	Description
protected ExecutionEntity	executionEntity
protected ProcessDefinitionEntity	processDefinitionEntity
protected MessageCorrelationResultType	resultType
protected String	startEventActivityId

Constructor Summary

Constructors

Constructor	Description
CorrelationHandlerResult()

Method Summary

Modifier and Type	Method	Description
Execution	getExecution()
ExecutionEntity	getExecutionEntity()
ProcessDefinition	getProcessDefinition()
ProcessDefinitionEntity	getProcessDefinitionEntity()
MessageCorrelationResultType	getResultType()
String	getStartEventActivityId()
static CorrelationHandlerResult	matchedExecution(ExecutionEntity executionEntity)
static CorrelationHandlerResult	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

resultType

protected MessageCorrelationResultType resultType

See Also:

MessageCorrelationResultType.Execution, MessageCorrelationResultType.ProcessDefinition

executionEntity

protected ExecutionEntity executionEntity

processDefinitionEntity

protected ProcessDefinitionEntity processDefinitionEntity

startEventActivityId

protected String startEventActivityId

Constructor Detail

CorrelationHandlerResult

public CorrelationHandlerResult()

Method Detail

matchedExecution

public static CorrelationHandlerResult matchedExecution(ExecutionEntity executionEntity)

matchedProcessDefinition

public static CorrelationHandlerResult matchedProcessDefinition(ProcessDefinitionEntity processDefinitionEntity,
                                                                String startEventActivityId)

getExecutionEntity

public ExecutionEntity getExecutionEntity()

getProcessDefinitionEntity

public ProcessDefinitionEntity getProcessDefinitionEntity()

getStartEventActivityId

public String getStartEventActivityId()

getResultType

public MessageCorrelationResultType getResultType()

getExecution

public Execution getExecution()

getProcessDefinition

public ProcessDefinition getProcessDefinition()