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

Interface CorrelationHandler

All Known Implementing Classes:
DefaultCorrelationHandler
public interface CorrelationHandler
Author:
Thorben Lindhauer, Daniel Meyer, Michael Scholz

  • Method Details

    • correlateMessage

      CorrelationHandlerResult 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<CorrelationHandlerResult> correlateMessages(CommandContext commandContext, String messageName, CorrelationSet correlationSet)
      Correlate the given message to all waiting executions and all process definitions which have 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.

    • correlateStartMessages

      List<CorrelationHandlerResult> correlateStartMessages(CommandContext commandContext, String messageName, CorrelationSet correlationSet)
      Correlate the given message to process definitions with a message start event.
      Parameters:
      correlationSet - any of its members may be null
      Returns:
      the matched correlation targets or an empty list if the message could not be correlated.