org.flowable.engine.impl.runtime

Class ProcessInstanceBuilderImpl

java.lang.Object

org.flowable.engine.impl.runtime.ProcessInstanceBuilderImpl

All Implemented Interfaces:

ProcessInstanceBuilder

public class ProcessInstanceBuilderImpl
extends Object
implements ProcessInstanceBuilder

Author:

Bassam Al-Sarori, Joram Barrez

Field Summary

Fields

Modifier and Type	Field and Description
protected String	businessKey
protected String	callbackId
protected String	callbackType
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 and Description
ProcessInstanceBuilderImpl(RuntimeServiceImpl runtimeService)

Method Summary

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.
String	getBusinessKey()
String	getCallbackId()
String	getCallbackType()
String	getMessageName()
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
String	getProcessInstanceName()
String	getTenantId()
Map<String,Object>	getTransientVariables()
Map<String,Object>	getVariables()
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

callbackId

protected String callbackId

callbackType

protected String callbackType

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

callbackId

public ProcessInstanceBuilder callbackId(String callbackId)

Description copied from interface: ProcessInstanceBuilder

Sets the callback identifier of the process instance.

Specified by:

callbackId in interface ProcessInstanceBuilder

callbackType

public ProcessInstanceBuilder callbackType(String callbackType)

Description copied from interface: ProcessInstanceBuilder

Sets the callback type of the process instance.

Specified by:

callbackType 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

start

public ProcessInstance start()

Description copied from interface: ProcessInstanceBuilder

Start the process instance

Specified by:

start in interface ProcessInstanceBuilder

getProcessDefinitionId

public String getProcessDefinitionId()

getProcessDefinitionKey

public String getProcessDefinitionKey()

getMessageName

public String getMessageName()

getProcessInstanceName

public String getProcessInstanceName()

getBusinessKey

public String getBusinessKey()

getCallbackId

public String getCallbackId()

getCallbackType

public String getCallbackType()

getTenantId

public String getTenantId()

getVariables

public Map<String,Object> getVariables()

getTransientVariables

public Map<String,Object> getTransientVariables()