org.camunda.bpm.engine.runtime

Interface MessageCorrelationResult

All Known Subinterfaces:

MessageCorrelationResultWithVariables

All Known Implementing Classes:

MessageCorrelationResultImpl

public interface MessageCorrelationResult

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()

Since:

7.6

Author:

Christopher Zell

Method Summary

Modifier and Type	Method and Description
Execution	getExecution() Returns the execution entity on which the message was correlated to.
ProcessInstance	getProcessInstance() Returns the process instance id on which the message was correlated to.
MessageCorrelationResultType	getResultType() Returns the result type of the message correlation result.

Method Detail

getExecution

Execution getExecution()

Returns the execution entity on which the message was correlated to.

Returns:

the execution

getProcessInstance

ProcessInstance getProcessInstance()

Returns the process instance id on which the message was correlated to.

Returns:

the process instance id

getResultType

MessageCorrelationResultType getResultType()

Returns the result type of the message correlation result. Indicates if either the message was correlated to a waiting execution or to a process definition like a start event.

Returns:

the result type of the message correlation result

See Also:

MessageCorrelationResultType}