org.camunda.bpm.engine.impl.runtime
Interface CorrelationHandler

All Known Implementing Classes:

DefaultCorrelationHandler

public interface CorrelationHandler

Author:

Thorben Lindhauer, Daniel Meyer, Michael Scholz

Method Summary

MessageCorrelationResult	correlateMessage(CommandContext commandContext, String messageName, CorrelationSet correlationSet) Correlate the given message to either a waiting execution or a process definition with a message start event.
List<MessageCorrelationResult>	correlateMessages(CommandContext commandContext, String messageName, CorrelationSet correlationSet) Correlate the given message to all waiting executions and a process definition with a message start event.
MessageCorrelationResult	correlateStartMessage(CommandContext commandContext, String messageName, CorrelationSet correlationSet) Correlate the given message to a process definition with a message start event.

Method Detail

correlateMessage

MessageCorrelationResult correlateMessage(CommandContext commandContext,
                                          String messageName,
                                          CorrelationSet correlationSet)

Correlate the given message to either a waiting execution or a process definition with a message start event.

Parameters:

correlationSet - any of its members may be null

Returns:

the matched correlation target or null if the message could not be correlated.

correlateMessages

List<MessageCorrelationResult> correlateMessages(CommandContext commandContext,
                                                 String messageName,
                                                 CorrelationSet correlationSet)

Correlate the given message to all waiting executions and a process definition with a message start event.

Parameters:

correlationSet - any of its members may be null

Returns:

all matched correlation targets or an empty List if the message could not be correlated.

correlateStartMessage

MessageCorrelationResult correlateStartMessage(CommandContext commandContext,
                                               String messageName,
                                               CorrelationSet correlationSet)

Correlate the given message to a process definition with a message start event.

Parameters:

correlationSet - any of its members may be null

Returns:

the matched correlation target or null if the message could not be correlated.