ProcessInstanceBuilder (Flowable

All Known Implementing Classes:

ProcessInstanceBuilderImpl
```
public interface ProcessInstanceBuilder
```
Helper for starting new ProcessInstance. An instance can be obtained through RuntimeService.createProcessInstanceBuilder(). processDefinitionId or processDefinitionKey should be set before calling start() to start a process instance.

Author:

Bassam Al-Sarori, Joram Barrez

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ProcessInstanceBuilder`	`businessKey(String businessKey)` Set the businessKey of process instance
`ProcessInstanceBuilder`	`callbackId(String callbackId)` Sets the callback identifier of the process instance.
`ProcessInstanceBuilder`	`callbackType(String callbackType)` Sets the callback type of the process instance.
`ProcessInstanceBuilder`	`fallbackToDefaultTenant()` Use default tenant as a fallback in the case when process definition was not found by key and tenant id
`ProcessInstanceBuilder`	`messageName(String messageName)` Set the message name that needs to be used to look up the process definition that needs to be used to start the process instance.
`ProcessInstanceBuilder`	`name(String processInstanceName)` Set the name of process instance
`ProcessInstanceBuilder`	`outcome(String outcome)` Allows to set an outcome for a start form.
`ProcessInstanceBuilder`	`overrideProcessDefinitionTenantId(String tenantId)` Indicator to override the tenant id of the process definition with the provided value.
`ProcessInstanceBuilder`	`predefineProcessInstanceId(String processInstanceId)` When starting a process instance from the CMMN engine process task, the process instance id needs to be known beforehand to store entity links and callback references before the process instance is started.
`ProcessInstanceBuilder`	`processDefinitionId(String processDefinitionId)` Set the id of the process definition
`ProcessInstanceBuilder`	`processDefinitionKey(String processDefinitionKey)` Set the key of the process definition, latest version of the process definition with the given key.
`ProcessInstance`	`start()` Start the process instance
`ProcessInstance`	`startAsync()` Start the process instance asynchronously
`ProcessInstanceBuilder`	`startFormVariable(String variableName, Object value)` Adds one variable from a start form to the process instance.
`ProcessInstanceBuilder`	`startFormVariables(Map<String,Object> startFormVariables)` Adds variables from a start form to the process instance.
`ProcessInstanceBuilder`	`tenantId(String tenantId)` Set the tenantId of to lookup the process definition
`ProcessInstanceBuilder`	`transientVariable(String variableName, Object value)` Adds a transient variable to the process instance
`ProcessInstanceBuilder`	`transientVariables(Map<String,Object> transientVariables)` Sets the transient variables
`ProcessInstanceBuilder`	`variable(String variableName, Object value)` Adds a variable to the process instance
`ProcessInstanceBuilder`	`variables(Map<String,Object> variables)` Sets the process variables

- Method Detail
  - processDefinitionId
```
ProcessInstanceBuilder processDefinitionId(String processDefinitionId)
```
    Set the id of the process definition
  - processDefinitionKey
```
ProcessInstanceBuilder processDefinitionKey(String processDefinitionKey)
```
    Set the key of the process definition, latest version of the process definition with the given key. If processDefinitionId was set this will be ignored
  - messageName
```
ProcessInstanceBuilder messageName(String messageName)
```
    Set the message name that needs to be used to look up the process definition that needs to be used to start the process instance.
  - name
```
ProcessInstanceBuilder name(String processInstanceName)
```
    Set the name of process instance
  - businessKey
```
ProcessInstanceBuilder businessKey(String businessKey)
```
    Set the businessKey of process instance
  - callbackId
```
ProcessInstanceBuilder callbackId(String callbackId)
```
    Sets the callback identifier of the process instance.
  - callbackType
```
ProcessInstanceBuilder callbackType(String callbackType)
```
    Sets the callback type of the process instance.
  - tenantId
```
ProcessInstanceBuilder tenantId(String tenantId)
```
    Set the tenantId of to lookup the process definition
  - overrideProcessDefinitionTenantId
```
ProcessInstanceBuilder overrideProcessDefinitionTenantId(String tenantId)
```
    Indicator to override the tenant id of the process definition with the provided value. The tenantId to lookup the process definition should still be provided if needed.
  - predefineProcessInstanceId
```
ProcessInstanceBuilder predefineProcessInstanceId(String processInstanceId)
```
    When starting a process instance from the CMMN engine process task, the process instance id needs to be known beforehand to store entity links and callback references before the process instance is started.
  - variables
```
ProcessInstanceBuilder variables(Map<String,Object> variables)
```
    Sets the process variables
  - variable
```
ProcessInstanceBuilder variable(String variableName,
                                Object value)
```
    Adds a variable to the process instance
  - transientVariables
```
ProcessInstanceBuilder transientVariables(Map<String,Object> transientVariables)
```
    Sets the transient variables
  - transientVariable
```
ProcessInstanceBuilder transientVariable(String variableName,
                                         Object value)
```
    Adds a transient variable to the process instance
  - startFormVariables
```
ProcessInstanceBuilder startFormVariables(Map<String,Object> startFormVariables)
```
    Adds variables from a start form to the process instance.
  - startFormVariable
```
ProcessInstanceBuilder startFormVariable(String variableName,
                                         Object value)
```
    Adds one variable from a start form to the process instance.
  - outcome
```
ProcessInstanceBuilder outcome(String outcome)
```
    Allows to set an outcome for a start form.
  - fallbackToDefaultTenant
```
ProcessInstanceBuilder fallbackToDefaultTenant()
```
    Use default tenant as a fallback in the case when process definition was not found by key and tenant id
  - start
```
ProcessInstance start()
```
    Start the process instance
    
    Throws:
    
    FlowableIllegalArgumentException - if processDefinitionKey and processDefinitionId are null
    
    FlowableObjectNotFoundException - when no process definition is deployed with the given processDefinitionKey or processDefinitionId
  - startAsync
```
ProcessInstance startAsync()
```
    Start the process instance asynchronously
    
    Throws:
    
    FlowableIllegalArgumentException - if processDefinitionKey and processDefinitionId are null
    
    FlowableObjectNotFoundException - when no process definition is deployed with the given processDefinitionKey or processDefinitionId

Interface ProcessInstanceBuilder

Method Summary

Method Detail

processDefinitionId

processDefinitionKey

messageName

name

businessKey

callbackId

callbackType

tenantId

overrideProcessDefinitionTenantId

predefineProcessInstanceId

variables

variable

transientVariables

transientVariable

startFormVariables

startFormVariable

outcome

fallbackToDefaultTenant

start

startAsync