dev.bpmcrafters.processengineapi.CommonRestrictions.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

/**
 * Helper to build restrictions for subscriptions or correlations.
 * @since 0.0.1
 */
object CommonRestrictions {

  /**
   * FIXME: consider to remove restriction names to adapters.
   */

  const val ACTIVITY_ID = "activityId"
  const val BUSINESS_KEY = "businessKey"
  const val CORRELATION_KEY = "correlationKey"
  const val PROCESS_DEFINITION_KEY = "processDefinitionKey"
  const val PROCESS_INSTANCE_ID = "processInstanceId"
  const val PROCESS_DEFINITION_ID = "processDefinitionId"
  const val PROCESS_DEFINITION_VERSION_TAG = "processDefinitionVersionTag"
  const val TASK_DEFINITION_KEY = "taskDefinitionKey"
  const val TENANT_ID = "tenantId"
  const val WITHOUT_TENANT_ID = "withoutTenantId"
  const val MESSAGE_ID = "messageId"
  const val MESSAGE_TTL = "messageTTL"
  const val EXECUTION_ID = "executionId"
  
  /**
   * Creates a helper restrictions builder.
   */
  @JvmStatic
  fun builder(): RestrictionsBuilder = RestrictionsBuilder()

  class RestrictionsBuilder internal constructor() {

    private val restrictions = mutableMapOf()

    fun withProcessDefinitionKey(processDefinitionKey: String) = this.apply {
      restrictions[PROCESS_DEFINITION_KEY] = processDefinitionKey
    }

    fun withTaskDefinitionKey(taskDefinitionKey: String) = this.apply {
      restrictions[TASK_DEFINITION_KEY] = taskDefinitionKey
    }

    fun withTenantId(tenantId: String) = this.apply {
      restrictions[TENANT_ID] = tenantId
    }

    fun withInstanceId(instanceId: String) = this.apply {
      restrictions[PROCESS_INSTANCE_ID] = instanceId
    }

    fun withActivityId(activityId: String) = this.apply {
      restrictions[ACTIVITY_ID] = activityId
    }

    fun withBusinessKey(businessKey: String) = this.apply {
      restrictions[BUSINESS_KEY] = businessKey
    }

    fun withCorrelationKey(correlationKey: String) = this.apply {
      restrictions[CORRELATION_KEY] = correlationKey
    }

    fun withRestriction(restriction: String, value: String) = this.apply {
      restrictions[restriction] = value
    }

    fun build(): Map = restrictions.toMap()
  }
}