java.lang.Object
- org.activiti.engine.impl.runtime.ProcessInstanceBuilderImpl

All Implemented Interfaces:: ProcessInstanceBuilder

public class ProcessInstanceBuilderImpl
extends Object
implements ProcessInstanceBuilder

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`businessKey`
`protected String`	`messageName`
`protected String`	`processDefinitionId`
`protected String`	`processDefinitionKey`
`protected String`	`processInstanceName`
`protected RuntimeServiceImpl`	`runtimeService`
`protected String`	`tenantId`
`protected Map<String,Object>`	`transientVariables`
`protected Map<String,Object>`	`variables`

Constructor Summary

Constructors
Constructor Description

ProcessInstanceBuilderImpl(RuntimeServiceImpl runtimeService)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ProcessInstanceBuilder`	`businessKey(String businessKey)`	Set the businessKey of process instance
`ProcessInstance`	`create()`	Create the process instance
`String`	`getBusinessKey()`
`String`	`getMessageName()`
`String`	`getProcessDefinitionId()`
`String`	`getProcessDefinitionKey()`
`String`	`getProcessInstanceName()`
`String`	`getTenantId()`
`Map<String,Object>`	`getTransientVariables()`
`Map<String,Object>`	`getVariables()`
`boolean`	`hasProcessDefinitionIdOrKey()`
`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`	`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
`ProcessInstanceBuilder`	`tenantId(String tenantId)`	Set the tenantId of process instance
`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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - runtimeService
```
protected RuntimeServiceImpl runtimeService
```
  - processDefinitionId
```
protected String processDefinitionId
```
  - processDefinitionKey
```
protected String processDefinitionKey
```
  - messageName
```
protected String messageName
```
  - processInstanceName
```
protected String processInstanceName
```
  - businessKey
```
protected String businessKey
```
  - tenantId
```
protected String tenantId
```
  - variables
```
protected Map<String,Object> variables
```
  - transientVariables
```
protected Map<String,Object> transientVariables
```
- Constructor Detail
  - ProcessInstanceBuilderImpl
```
public ProcessInstanceBuilderImpl(RuntimeServiceImpl runtimeService)
```
- Method Detail
  - processDefinitionId
```
public ProcessInstanceBuilder processDefinitionId(String processDefinitionId)
```
    Description copied from interface: ProcessInstanceBuilder
    
    Set the id of the process definition
    
    Specified by:
    
    processDefinitionId in interface ProcessInstanceBuilder
  - processDefinitionKey
```
public ProcessInstanceBuilder processDefinitionKey(String processDefinitionKey)
```
    Description copied from interface: ProcessInstanceBuilder
    
    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
    
    Specified by:
    
    processDefinitionKey in interface ProcessInstanceBuilder
  - messageName
```
public ProcessInstanceBuilder messageName(String messageName)
```
    Description copied from interface: ProcessInstanceBuilder
    
    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.
    
    Specified by:
    
    messageName in interface ProcessInstanceBuilder
  - name
```
public ProcessInstanceBuilder name(String processInstanceName)
```
    Description copied from interface: ProcessInstanceBuilder
    
    Set the name of process instance
    
    Specified by:
    
    name in interface ProcessInstanceBuilder
  - businessKey
```
public ProcessInstanceBuilder businessKey(String businessKey)
```
    Description copied from interface: ProcessInstanceBuilder
    
    Set the businessKey of process instance
    
    Specified by:
    
    businessKey in interface ProcessInstanceBuilder
  - tenantId
```
public ProcessInstanceBuilder tenantId(String tenantId)
```
    Description copied from interface: ProcessInstanceBuilder
    
    Set the tenantId of process instance
    
    Specified by:
    
    tenantId in interface ProcessInstanceBuilder
  - variables
```
public ProcessInstanceBuilder variables(Map<String,Object> variables)
```
    Description copied from interface: ProcessInstanceBuilder
    
    Sets the process variables
    
    Specified by:
    
    variables in interface ProcessInstanceBuilder
  - variable
```
public ProcessInstanceBuilder variable(String variableName,
                                       Object value)
```
    Description copied from interface: ProcessInstanceBuilder
    
    Adds a variable to the process instance
    
    Specified by:
    
    variable in interface ProcessInstanceBuilder
  - transientVariables
```
public ProcessInstanceBuilder transientVariables(Map<String,Object> transientVariables)
```
    Description copied from interface: ProcessInstanceBuilder
    
    Sets the transient variables
    
    Specified by:
    
    transientVariables in interface ProcessInstanceBuilder
  - transientVariable
```
public ProcessInstanceBuilder transientVariable(String variableName,
                                                Object value)
```
    Description copied from interface: ProcessInstanceBuilder
    
    Adds a transient variable to the process instance
    
    Specified by:
    
    transientVariable in interface ProcessInstanceBuilder
  - hasProcessDefinitionIdOrKey
```
public boolean hasProcessDefinitionIdOrKey()
```
  - start
```
public ProcessInstance start()
```
    Description copied from interface: ProcessInstanceBuilder
    
    Start the process instance
    
    Specified by:
    
    start in interface ProcessInstanceBuilder
  - create
```
public ProcessInstance create()
```
    Description copied from interface: ProcessInstanceBuilder
    
    Create the process instance
    
    Specified by:
    
    create in interface ProcessInstanceBuilder
  - getProcessDefinitionId
```
public String getProcessDefinitionId()
```
  - getProcessDefinitionKey
```
public String getProcessDefinitionKey()
```
  - getMessageName
```
public String getMessageName()
```
  - getProcessInstanceName
```
public String getProcessInstanceName()
```
  - getBusinessKey
```
public String getBusinessKey()
```
  - getTenantId
```
public String getTenantId()
```
  - getVariables
```
public Map<String,Object> getVariables()
```
  - getTransientVariables
```
public Map<String,Object> getTransientVariables()
```

Class ProcessInstanceBuilderImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

runtimeService

processDefinitionId

processDefinitionKey

messageName

processInstanceName

businessKey

tenantId

variables

transientVariables

Constructor Detail

ProcessInstanceBuilderImpl

Method Detail

processDefinitionId

processDefinitionKey

messageName

name

businessKey

tenantId

variables

variable

transientVariables

transientVariable

hasProcessDefinitionIdOrKey

start

create

getProcessDefinitionId

getProcessDefinitionKey

getMessageName

getProcessInstanceName

getBusinessKey

getTenantId

getVariables

getTransientVariables