org.apache.ode.bpel.common

## Class OptionalCorrelationKey

- java.lang.Object
- - org.apache.ode.bpel.common.CorrelationKey
  - - org.apache.ode.bpel.common.OptionalCorrelationKey

- All Implemented Interfaces:
    java.io.Serializable

      public class OptionalCorrelationKey
      extends CorrelationKey
      implements java.io.Serializable

  An instance of this class represents a correlation key that has a 'join' use case in the process definition. For instance, if a correlation set, 'orderId' is used as initiate="no" in 3 occurrences and initiate="join" in 1 occurrence, any correlation keys that are derived from the correlation set, 'orderId' is an optional correlation key.
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `OptionalCorrelationKey(java.lang.String canonicalForm)`
    `OptionalCorrelationKey(java.lang.String csetName, java.lang.String[] keyValues)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `toString()`

    - ### Methods inherited from class org.apache.ode.bpel.common.CorrelationKey

      `equals, getCorrelationSetName, getValues, hashCode, isMatch, toCanonicalString`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### OptionalCorrelationKey

          public OptionalCorrelationKey(java.lang.String csetName,
                                java.lang.String[] keyValues)

    - #### OptionalCorrelationKey

          public OptionalCorrelationKey(java.lang.String canonicalForm)

  - ### Method Detail

    - #### toString

          public java.lang.String toString()

      Overrides:
        `toString` in class `CorrelationKey`
      See Also:
        `Object.toString()`