Package io.jmix.bpmui.processform

Interface ProcessStarting

All Known Implementing Classes:
ProcessStartingImpl
public interface ProcessStarting
A process starting builder used in custom process forms.
See Also:

  • Method Details

    • withFrameOwner

      ProcessStarting withFrameOwner(FrameOwner frameOwner)

    • withProcessDefinition

      ProcessStarting withProcessDefinition(org.flowable.engine.repository.ProcessDefinition processDefinition)

    • withBusinessKey

      ProcessStarting withBusinessKey(String businessKey)

    • withProcessVariables

      ProcessStarting withProcessVariables(Map<String,Object> processVariables)

    • addProcessVariable

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

    • saveInjectedProcessVariables

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

      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.

    • start

      org.flowable.engine.runtime.ProcessInstance start()
      Starts the process using the ProcessDefinition from the ProcessFormContextImpl