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

/**
 * Command to subscribe to tasks.
 * @since 0.0.1
 */
data class SubscribeForTaskCmd(
  /**
   * Defines a set of restrictions evaluated by the engine adapter.
   */
  val restrictions: Map,
  /**
   * Task type.
   */
  val taskType: TaskType,
  /**
   * May refer to BPMN 2.0 attribute `implementation` or `operation[@implementationRef]` or
   * any engine-specific attribute of the task XML-tag. As a fallback an adapter-implementation
   * should also accept a task's `id` attribute, since this the only common attribute in all engines.
   */
  val taskDescriptionKey: String?,
  /**
   * Limitation of the payload variables to be delivered to the action.
   * If empty, no variables should be provided.
   * If non-empty, the variables are limited to those, provided in the list.
   * If null, all variables are provided.
   */
  val payloadDescription: Set? = null,
  /**
   * Action to deliver the task to.
   */
  val action: TaskHandler,
  /**
   * Action to execute if the delivered task is terminated.
   */
  val termination: TaskTerminationHandler
)