dev.bpmcrafters.processengineapi.correlation.Correlation.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of process-engine-api Show documentation

Java API for engine-independent process functionality.

There is a newer version: 0.3.0

package dev.bpmcrafters.processengineapi.correlation

/**
 * Correlation information.
 * @since 0.0.1
 */
data class Correlation private constructor(
  /**
   * Correlation key.
   */
  val correlationKey: String,
  /**
   * If the engine is not supporting the correlation by key, defines the name of the local variable used to access correlation.
   */
  val correlationVariable: String = "correlationKey"
) {
  companion object {
    /**
     * Constructs correlation based on key, using default variable name.
     * @param key correlation key.
     * @return correlation
     */
    @JvmStatic
    fun withKey(key: String): Correlation {
      return Correlation(correlationKey = key)
    }
  }

  /**
   * Modifies the name for correlation variable.
   * @param variable name of the (local) variable used to correlate.
   * @return correlation.
   */
  fun withVariable(variable: String): Correlation {
    return this.copy(correlationVariable = variable)
  }
}