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 and return the MessageCorrelationResult that matches it.
List<MessageCorrelationResult>	correlateMessages(CommandContext commandContext, String messageName, CorrelationSet correlationSet) Correlate all given messages and return a List of MessageCorrelationResults that matches them.

Method Detail

correlateMessage

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

Correlate the given message and return the MessageCorrelationResult that matches it. Return null if the message could not be correlated.

Parameters:

commandContext -

messageName -

correlationSet - any of its members may be null

Returns:

correlateMessages

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

Correlate all given messages and return a List of MessageCorrelationResults that matches them. Return any empty List if no message could not be correlated.

Parameters:

commandContext -

messageName -

correlationSet - any of its members may be null

Returns: