Package 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	Description
protected String	assigneeId
protected String	businessKey
protected String	businessStatus
protected String	callbackId
protected String	callbackType
protected FormInfo	extraFormInfo
protected String	extraFormOutcome
protected Map<String,Object>	extraFormVariables
protected boolean	fallbackToDefaultTenant
protected String	messageName
protected String	outcome
protected String	overrideDefinitionTenantId
protected String	ownerId
protected String	predefinedProcessInstanceId
protected String	processDefinitionId
protected String	processDefinitionKey
protected String	processDefinitionParentDeploymentId
protected String	processInstanceName
protected String	referenceId
protected String	referenceType
protected RuntimeServiceImpl	runtimeService
protected String	stageInstanceId
protected String	startEventId
protected Map<String,Object>	startFormVariables
protected String	tenantId
protected Map<String,Object>	transientVariables
protected Map<String,Object>	variables

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceBuilderImpl(RuntimeServiceImpl runtimeService)

Method Summary

Modifier and Type	Method	Description
ProcessInstanceBuilder	assignee(String userId)	Set the assignee of the process instance to be created to the given user id.
ProcessInstanceBuilder	businessKey(String businessKey)	Set the businessKey of process instance
ProcessInstanceBuilder	businessStatus(String businessStatus)	Set the businessStatus 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	formVariables(Map<String,Object> formVariables, FormInfo formInfo, String formOutcome)	Start the process instance with the given form variables from the given formInfo.
String	getAssigneeId()
String	getBusinessKey()
String	getBusinessStatus()
String	getCallbackId()
String	getCallbackType()
FormInfo	getExtraFormInfo()
String	getExtraFormOutcome()
Map<String,Object>	getExtraFormVariables()
String	getMessageName()
String	getOutcome()
String	getOverrideDefinitionTenantId()
String	getOwnerId()
String	getPredefinedProcessInstanceId()
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
String	getProcessDefinitionParentDeploymentId()
String	getProcessInstanceName()
String	getReferenceId()
String	getReferenceType()
String	getStageInstanceId()
String	getStartEventId()
Map<String,Object>	getStartFormVariables()
String	getTenantId()
Map<String,Object>	getTransientVariables()
Map<String,Object>	getVariables()
boolean	isFallbackToDefaultTenant()
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	owner(String userId)	Set the owner of the process instance to be created to the given user id.
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.
ProcessInstanceBuilder	processDefinitionParentDeploymentId(String parentDeploymentId)	When looking up for a process definition by key it would first lookup for a process definition within the given parent deployment.
ProcessInstanceBuilder	referenceId(String referenceId)	Sets the reference identifier of the process instance.
ProcessInstanceBuilder	referenceType(String referenceType)	Sets the reference type of the process instance.
ProcessInstanceBuilder	stageInstanceId(String stageInstanceId)	Set the optional instance id of the stage this process instance belongs to, if it runs in the context of a CMMN case.
ProcessInstance	start()	Start the process instance
ProcessInstance	startAsync()	Start the process instance asynchronously
ProcessInstanceBuilder	startEventId(String startEventId)	Set the start event in case of an event registry start event that is triggered to start the process instance.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

runtimeService

protected RuntimeServiceImpl runtimeService

processDefinitionId

protected String processDefinitionId

processDefinitionKey

protected String processDefinitionKey

processDefinitionParentDeploymentId

protected String processDefinitionParentDeploymentId

messageName

protected String messageName

startEventId

protected String startEventId

processInstanceName

protected String processInstanceName

businessKey

protected String businessKey

businessStatus

protected String businessStatus

callbackId

protected String callbackId

callbackType

protected String callbackType

referenceId

protected String referenceId

referenceType

protected String referenceType

stageInstanceId

protected String stageInstanceId

tenantId

protected String tenantId

ownerId

protected String ownerId

assigneeId

protected String assigneeId

overrideDefinitionTenantId

protected String overrideDefinitionTenantId

predefinedProcessInstanceId

protected String predefinedProcessInstanceId

variables

protected Map<String,Object> variables

transientVariables

protected Map<String,Object> transientVariables

startFormVariables

protected Map<String,Object> startFormVariables

outcome

protected String outcome

extraFormVariables

protected Map<String,Object> extraFormVariables

extraFormInfo

protected FormInfo extraFormInfo

extraFormOutcome

protected String extraFormOutcome

fallbackToDefaultTenant

protected boolean fallbackToDefaultTenant

Constructor Details

ProcessInstanceBuilderImpl

public ProcessInstanceBuilderImpl(RuntimeServiceImpl runtimeService)

Method Details

processDefinitionId

public ProcessInstanceBuilder processDefinitionId(String processDefinitionId)

Description copied from interface: ProcessInstanceBuilder

Set the id of the process definition

Specified by:

processDefinitionId in interface ProcessInstanceBuilder

processDefinitionParentDeploymentId

public ProcessInstanceBuilder processDefinitionParentDeploymentId(String parentDeploymentId)

Description copied from interface: ProcessInstanceBuilder

When looking up for a process definition by key it would first lookup for a process definition within the given parent deployment. Then it would fallback to the latest process definition with the given key.

This is typically needed when the ProcessInstanceBuilder is called for example from the case engine to start a process instance and it needs to look up the process definition in the same deployment as the case.

Specified by:

processDefinitionParentDeploymentId 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

startEventId

public ProcessInstanceBuilder startEventId(String startEventId)

Description copied from interface: ProcessInstanceBuilder

Set the start event in case of an event registry start event that is triggered to start the process instance.

Specified by:

startEventId 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

businessStatus

public ProcessInstanceBuilder businessStatus(String businessStatus)

Description copied from interface: ProcessInstanceBuilder

Set the businessStatus of process instance

Specified by:

businessStatus 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

referenceId

public ProcessInstanceBuilder referenceId(String referenceId)

Description copied from interface: ProcessInstanceBuilder

Sets the reference identifier of the process instance.

Specified by:

referenceId in interface ProcessInstanceBuilder

referenceType

public ProcessInstanceBuilder referenceType(String referenceType)

Description copied from interface: ProcessInstanceBuilder

Sets the reference type of the process instance.

Specified by:

referenceType in interface ProcessInstanceBuilder

stageInstanceId

public ProcessInstanceBuilder stageInstanceId(String stageInstanceId)

Description copied from interface: ProcessInstanceBuilder

Set the optional instance id of the stage this process instance belongs to, if it runs in the context of a CMMN case.

Specified by:

stageInstanceId in interface ProcessInstanceBuilder

tenantId

public ProcessInstanceBuilder tenantId(String tenantId)

Description copied from interface: ProcessInstanceBuilder

Set the tenantId of to lookup the process definition

Specified by:

tenantId in interface ProcessInstanceBuilder

overrideProcessDefinitionTenantId

public ProcessInstanceBuilder overrideProcessDefinitionTenantId(String tenantId)

Description copied from interface: ProcessInstanceBuilder

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.

Specified by:

overrideProcessDefinitionTenantId in interface ProcessInstanceBuilder

predefineProcessInstanceId

public ProcessInstanceBuilder predefineProcessInstanceId(String processInstanceId)

Description copied from interface: ProcessInstanceBuilder

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.

Specified by:

predefineProcessInstanceId in interface ProcessInstanceBuilder

owner

public ProcessInstanceBuilder owner(String userId)

Description copied from interface: ProcessInstanceBuilder

Set the owner of the process instance to be created to the given user id.

Specified by:

owner in interface ProcessInstanceBuilder

Parameters:

userId - the id of the user to become the owner of the process instance

Returns:

the process instance builder for method chaining

assignee

public ProcessInstanceBuilder assignee(String userId)

Description copied from interface: ProcessInstanceBuilder

Set the assignee of the process instance to be created to the given user id.

Specified by:

assignee in interface ProcessInstanceBuilder

Parameters:

userId - the id of the user to become the owner of the process instance

Returns:

the process instance builder for method chaining

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

startFormVariables

public ProcessInstanceBuilder startFormVariables(Map<String,Object> startFormVariables)

Description copied from interface: ProcessInstanceBuilder

Adds variables from a start form to the process instance.

Specified by:

startFormVariables in interface ProcessInstanceBuilder

startFormVariable

public ProcessInstanceBuilder startFormVariable(String variableName,
 Object value)

Description copied from interface: ProcessInstanceBuilder

Adds one variable from a start form to the process instance.

Specified by:

startFormVariable in interface ProcessInstanceBuilder

outcome

public ProcessInstanceBuilder outcome(String outcome)

Description copied from interface: ProcessInstanceBuilder

Allows to set an outcome for a start form.

Specified by:

outcome in interface ProcessInstanceBuilder

formVariables

public ProcessInstanceBuilder formVariables(Map<String,Object> formVariables,
 FormInfo formInfo,
 String formOutcome)

Description copied from interface: ProcessInstanceBuilder

Start the process instance with the given form variables from the given formInfo. This is different than ProcessInstanceBuilder.startFormVariables(Map) and it can be used in addition to that.

Specified by:

formVariables in interface ProcessInstanceBuilder

fallbackToDefaultTenant

public ProcessInstanceBuilder fallbackToDefaultTenant()

Description copied from interface: ProcessInstanceBuilder

Use default tenant as a fallback in the case when process definition was not found by key and tenant id

Specified by:

fallbackToDefaultTenant in interface ProcessInstanceBuilder

start

public ProcessInstance start()

Description copied from interface: ProcessInstanceBuilder

Start the process instance

Specified by:

start in interface ProcessInstanceBuilder

startAsync

public ProcessInstance startAsync()

Description copied from interface: ProcessInstanceBuilder

Start the process instance asynchronously

Specified by:

startAsync in interface ProcessInstanceBuilder

getProcessDefinitionId

public String getProcessDefinitionId()

getProcessDefinitionKey

public String getProcessDefinitionKey()

getProcessDefinitionParentDeploymentId

public String getProcessDefinitionParentDeploymentId()

getMessageName

public String getMessageName()

getStartEventId

public String getStartEventId()

getProcessInstanceName

public String getProcessInstanceName()

getBusinessKey

public String getBusinessKey()

getBusinessStatus

public String getBusinessStatus()

getCallbackId

public String getCallbackId()

getCallbackType

public String getCallbackType()

getReferenceId

public String getReferenceId()

getReferenceType

public String getReferenceType()

getStageInstanceId

public String getStageInstanceId()

getTenantId

public String getTenantId()

getOverrideDefinitionTenantId

public String getOverrideDefinitionTenantId()

getPredefinedProcessInstanceId

public String getPredefinedProcessInstanceId()

getOwnerId

public String getOwnerId()

getAssigneeId

public String getAssigneeId()

getVariables

public Map<String,Object> getVariables()

getTransientVariables

public Map<String,Object> getTransientVariables()

getStartFormVariables

public Map<String,Object> getStartFormVariables()

getOutcome

public String getOutcome()

getExtraFormVariables

public Map<String,Object> getExtraFormVariables()

getExtraFormInfo

public FormInfo getExtraFormInfo()

getExtraFormOutcome

public String getExtraFormOutcome()

isFallbackToDefaultTenant

public boolean isFallbackToDefaultTenant()