Package io.jmix.bpmflowui.processform

Interface TaskCompletion

All Known Implementing Classes:
TaskCompletionImpl
public interface TaskCompletion
A user task completion builder used in custom process forms
See Also:

  • Method Details

    • withOrigin

      TaskCompletion withOrigin(View origin)

    • withTask

      TaskCompletion withTask(org.flowable.task.api.Task task)

    • withProcessVariables

      TaskCompletion withProcessVariables(Map<String,Object> processVariables)

    • addProcessVariable

      TaskCompletion addProcessVariable(String name, Object value)
      Adds a single process variable. Multiple sequential invocations of the method are allowed
      Parameters:
      name - process variable name
      value - process variable value

    • withOutcome

      TaskCompletion withOutcome(String outcome)

    • saveInjectedProcessVariables

      TaskCompletion saveInjectedProcessVariables()
      Values of form fields that are annotated with the ProcessVariable will be collected and written to process variables when the task is completed.

      If the operation is invoked from within the ScreenFragment then process variables will be collected not only from the current fragment but also from the host screen and from all other fragments included to the host screen.

    • complete

      void complete()
      Completes the task using the Task from the ProcessFormContextImpl