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

import dev.bpmcrafters.processengineapi.Empty
import java.util.concurrent.Future

/**
 * API for completion of service tasks.
 * @since 0.0.1
 */
interface ExternalTaskCompletionApi {
  /**
   * Complete the task.
   * @param cmd command to complete the task.
   * @return future indicating the completion.
   */
  fun completeTask(cmd: CompleteTaskCmd): Future

  /**
   * Completes the task by throwing an BPMN error.
   * @param cmd command to complete the task.
   * @return future indicating the completion.
   */
  fun completeTaskByError(cmd: CompleteTaskByErrorCmd): Future

  /**
   * Failes to complete the task because of a technical failure.
   * @param cmd command to indicate failure.
   * @return future indicating the failure.
   */
  fun failTask(cmd: FailTaskCmd): Future

}