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:

ProcessFormContextImpl

Method Summary

Modifier and Type	Method and Description
ProcessStarting	addProcessVariable(java.lang.String name, java.lang.Object value) Adds a single process variable.
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.
org.flowable.engine.runtime.ProcessInstance	start() Starts the process using the ProcessDefinition from the ProcessFormContextImpl
ProcessStarting	withBusinessKey(java.lang.String businessKey)
ProcessStarting	withFrameOwner(io.jmix.ui.screen.FrameOwner frameOwner)
ProcessStarting	withProcessDefinition(org.flowable.engine.repository.ProcessDefinition processDefinition)
ProcessStarting	withProcessVariables(java.util.Map<java.lang.String,java.lang.Object> processVariables)

Method Detail

withFrameOwner

ProcessStarting withFrameOwner(io.jmix.ui.screen.FrameOwner frameOwner)

withProcessDefinition

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

withBusinessKey

ProcessStarting withBusinessKey(java.lang.String businessKey)

withProcessVariables

ProcessStarting withProcessVariables(java.util.Map<java.lang.String,java.lang.Object> processVariables)

addProcessVariable

ProcessStarting addProcessVariable(java.lang.String name,
                                   java.lang.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