Package org.flowable.cmmn.engine.impl.runtime

Class CaseInstanceBuilderImpl

java.lang.Object

org.flowable.cmmn.engine.impl.runtime.CaseInstanceBuilderImpl

All Implemented Interfaces:

CaseInstanceBuilder

public class CaseInstanceBuilderImpl
extends Object
implements CaseInstanceBuilder

Author:

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 String	caseDefinitionId
protected String	caseDefinitionKey
protected String	caseDefinitionParentDeploymentId
protected CmmnRuntimeServiceImpl	cmmnRuntimeService
protected boolean	fallbackToDefaultTenant
protected String	name
protected String	outcome
protected String	overrideDefinitionTenantId
protected String	ownerId
protected String	parentId
protected String	predefinedCaseInstanceId
protected String	referenceId
protected String	referenceType
protected Map<String,Object>	startFormVariables
protected boolean	startWithForm
protected String	tenantId
protected Map<String,Object>	transientVariables
protected Map<String,Object>	variables

Constructor Summary

Constructors

Constructor	Description
CaseInstanceBuilderImpl()
CaseInstanceBuilderImpl(CmmnRuntimeServiceImpl cmmnRuntimeService)

Method Summary

Modifier and Type	Method	Description
CaseInstanceBuilder	assignee(String userId)	Set the assignee of the case to be created to the given user id.
CaseInstanceBuilder	businessKey(String businessKey)
CaseInstanceBuilder	businessStatus(String businessStatus)
CaseInstanceBuilder	callbackId(String callbackId)	Set callback id of the newly created case instance.
CaseInstanceBuilder	callbackType(String callbackType)	Set callback type of the newly created case instance.
CaseInstanceBuilder	caseDefinitionId(String caseDefinitionId)	Set the case definition to be used for creating a new case instance by its id.
CaseInstanceBuilder	caseDefinitionKey(String caseDefinitionKey)	Set the case definition to be used for creating a new case instance by its key.
CaseInstanceBuilder	caseDefinitionParentDeploymentId(String parentDeploymentId)	When looking up for a case definition by key it would first lookup for a case definition within the given parent deployment.
CaseInstanceBuilder	fallbackToDefaultTenant()	If case definition is not found by key in the specified tenant use default tenant search as a fallback
String	getAssignee()
String	getBusinessKey()
String	getBusinessStatus()
String	getCallbackId()
String	getCallbackType()
String	getCaseDefinitionId()
String	getCaseDefinitionKey()
String	getCaseDefinitionParentDeploymentId()
String	getName()
String	getOutcome()
String	getOverrideDefinitionTenantId()
String	getOwner()
String	getParentId()
String	getPredefinedCaseInstanceId()
String	getReferenceId()
String	getReferenceType()
Map<String,Object>	getStartFormVariables()
String	getTenantId()
Map<String,Object>	getTransientVariables()
Map<String,Object>	getVariables()
boolean	isFallbackToDefaultTenant()
boolean	isStartWithForm()
CaseInstanceBuilder	name(String name)
CaseInstanceBuilder	outcome(String outcome)	Saves the outcome of the start form for the case, if this case should be started out of a start form.
CaseInstanceBuilder	overrideCaseDefinitionTenantId(String tenantId)	Indicator to override the tenant id of the case definition with the provided value.
CaseInstanceBuilder	owner(String userId)	Set the owner of the case to be created to the given user id.
CaseInstanceBuilder	parentId(String parentCaseInstanceId)	Set parent case instanceId of the newly create case instance
CaseInstanceBuilder	predefinedCaseInstanceId(String caseInstanceId)	If the new case instance should have a predefined id, you can set it using this method.
CaseInstanceBuilder	referenceId(String referenceId)	Set the reference id on the newly create case instance.
CaseInstanceBuilder	referenceType(String referenceType)	Set the reference type on the newly create case instance.
CaseInstance	start()	Once all the information is set using this builder API, the start method will create the case instance, initialize it according all the data in the builder and then evaluate the case model to start the case.
CaseInstance	startAsync()	Once all the information is set using this builder API, the startAsync method will create the case instance and initialize its data, but the case model is not yet evaluated, but will be started and evaluated asynchronously in a different transaction.
CaseInstanceBuilder	startFormVariables(Map<String,Object> formVariables)	Allows to pass any variables if they come from a form.
CaseInstance	startWithForm()	Once all the information is set using this builder API, the startWithForm method will create the case instance and initialize its data by additionally using the submitted form variables and handling them with the start form provided with the case model (e.g.
CaseInstanceBuilder	tenantId(String tenantId)
CaseInstanceBuilder	transientVariable(String variableName, Object value)
CaseInstanceBuilder	transientVariables(Map<String,Object> transientVariables)
CaseInstanceBuilder	variable(String variableName, Object value)
CaseInstanceBuilder	variables(Map<String,Object> variables)

Methods inherited from class java.lang.Object

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

Field Details

cmmnRuntimeService

protected CmmnRuntimeServiceImpl cmmnRuntimeService

caseDefinitionId

protected String caseDefinitionId

caseDefinitionKey

protected String caseDefinitionKey

caseDefinitionParentDeploymentId

protected String caseDefinitionParentDeploymentId

predefinedCaseInstanceId

protected String predefinedCaseInstanceId

name

protected String name

businessKey

protected String businessKey

businessStatus

protected String businessStatus

variables

protected Map<String,Object> variables

transientVariables

protected Map<String,Object> transientVariables

tenantId

protected String tenantId

ownerId

protected String ownerId

assigneeId

protected String assigneeId

overrideDefinitionTenantId

protected String overrideDefinitionTenantId

outcome

protected String outcome

startFormVariables

protected Map<String,Object> startFormVariables

callbackType

protected String callbackType

callbackId

protected String callbackId

referenceId

protected String referenceId

referenceType

protected String referenceType

parentId

protected String parentId

fallbackToDefaultTenant

protected boolean fallbackToDefaultTenant

startWithForm

protected boolean startWithForm

Constructor Details

CaseInstanceBuilderImpl

public CaseInstanceBuilderImpl()

CaseInstanceBuilderImpl

public CaseInstanceBuilderImpl(CmmnRuntimeServiceImpl cmmnRuntimeService)

Method Details

caseDefinitionId

public CaseInstanceBuilder caseDefinitionId(String caseDefinitionId)

Description copied from interface: CaseInstanceBuilder

Set the case definition to be used for creating a new case instance by its id. If both the case definition id and the key are set, the id takes precedence and the key will be ignored. At least one of them needs to be specified within the builder.

Specified by:

caseDefinitionId in interface CaseInstanceBuilder

Parameters:

caseDefinitionId - the id of the case definition the new case should be based on

Returns:

the case instance builder for method chaining

caseDefinitionKey

public CaseInstanceBuilder caseDefinitionKey(String caseDefinitionKey)

Description copied from interface: CaseInstanceBuilder

Set the case definition to be used for creating a new case instance by its key. If both the case definition id and the key are set, the id takes precedence and the key will be ignored. At least one of them needs to be specified within the builder.

Specified by:

caseDefinitionKey in interface CaseInstanceBuilder

Parameters:

caseDefinitionKey - the key of the case definition the new case should be based on

Returns:

the case instance builder for method chaining

caseDefinitionParentDeploymentId

public CaseInstanceBuilder caseDefinitionParentDeploymentId(String parentDeploymentId)

Description copied from interface: CaseInstanceBuilder

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

This is typically needed when the CaseInstanceBuilder is called for example from the process engine to start a case instance and it needs to lookup the case definition in the same deployment as the process. Or when starting a case via a case task from the cmmn engine

Specified by:

caseDefinitionParentDeploymentId in interface CaseInstanceBuilder

predefinedCaseInstanceId

public CaseInstanceBuilder predefinedCaseInstanceId(String caseInstanceId)

Description copied from interface: CaseInstanceBuilder

If the new case instance should have a predefined id, you can set it using this method. If that predefined id is set, it will be used instead of creating a new one automatically.

Specified by:

predefinedCaseInstanceId in interface CaseInstanceBuilder

Parameters:

caseInstanceId - the id of the new case instance to be used

Returns:

the case instance builder for method chaining

name

public CaseInstanceBuilder name(String name)

Specified by:

name in interface CaseInstanceBuilder

businessKey

public CaseInstanceBuilder businessKey(String businessKey)

Specified by:

businessKey in interface CaseInstanceBuilder

businessStatus

public CaseInstanceBuilder businessStatus(String businessStatus)

Specified by:

businessStatus in interface CaseInstanceBuilder

variables

public CaseInstanceBuilder variables(Map<String,Object> variables)

Specified by:

variables in interface CaseInstanceBuilder

variable

public CaseInstanceBuilder variable(String variableName,
 Object value)

Specified by:

variable in interface CaseInstanceBuilder

transientVariables

public CaseInstanceBuilder transientVariables(Map<String,Object> transientVariables)

Specified by:

transientVariables in interface CaseInstanceBuilder

transientVariable

public CaseInstanceBuilder transientVariable(String variableName,
 Object value)

Specified by:

transientVariable in interface CaseInstanceBuilder

tenantId

public CaseInstanceBuilder tenantId(String tenantId)

Specified by:

tenantId in interface CaseInstanceBuilder

owner

public CaseInstanceBuilder owner(String userId)

Description copied from interface: CaseInstanceBuilder

Set the owner of the case to be created to the given user id.

Specified by:

owner in interface CaseInstanceBuilder

Parameters:

userId - the id of the user to become the owner of the case

Returns:

the case instance builder for method chaining

assignee

public CaseInstanceBuilder assignee(String userId)

Description copied from interface: CaseInstanceBuilder

Set the assignee of the case to be created to the given user id.

Specified by:

assignee in interface CaseInstanceBuilder

Parameters:

userId - the id of the user to become the assignee of the case

Returns:

the case instance builder for method chaining

overrideCaseDefinitionTenantId

public CaseInstanceBuilder overrideCaseDefinitionTenantId(String tenantId)

Description copied from interface: CaseInstanceBuilder

Indicator to override the tenant id of the case definition with the provided value. The tenantId to lookup the case definition should still be provided if needed.

Specified by:

overrideCaseDefinitionTenantId in interface CaseInstanceBuilder

outcome

public CaseInstanceBuilder outcome(String outcome)

Description copied from interface: CaseInstanceBuilder

Saves the outcome of the start form for the case, if this case should be started out of a start form. You can additionally save any form variables along with the outcome and start the case using CaseInstanceBuilder.startWithForm().

Specified by:

outcome in interface CaseInstanceBuilder

Parameters:

outcome - the outcome to be registered in the builder

Returns:

the case instance builder for method chaining

startFormVariables

public CaseInstanceBuilder startFormVariables(Map<String,Object> formVariables)

Description copied from interface: CaseInstanceBuilder

Allows to pass any variables if they come from a form. The difference with regular CaseInstanceBuilder.variables(Map) is that the start form will be fetched and the variables matched with the FormInfo.

Specified by:

startFormVariables in interface CaseInstanceBuilder

callbackId

public CaseInstanceBuilder callbackId(String callbackId)

Description copied from interface: CaseInstanceBuilder

Set callback id of the newly created case instance.

Specified by:

callbackId in interface CaseInstanceBuilder

Parameters:

callbackId - id of the callback

Returns:

case instance builder which creates case instance with defined callback id

callbackType

public CaseInstanceBuilder callbackType(String callbackType)

Description copied from interface: CaseInstanceBuilder

Set callback type of the newly created case instance.

Specified by:

callbackType in interface CaseInstanceBuilder

Parameters:

callbackType - type of the callback

Returns:

case instance builder which creates case instance with defined callback type

referenceId

public CaseInstanceBuilder referenceId(String referenceId)

Description copied from interface: CaseInstanceBuilder

Set the reference id on the newly create case instance.

Specified by:

referenceId in interface CaseInstanceBuilder

referenceType

public CaseInstanceBuilder referenceType(String referenceType)

Description copied from interface: CaseInstanceBuilder

Set the reference type on the newly create case instance.

Specified by:

referenceType in interface CaseInstanceBuilder

parentId

public CaseInstanceBuilder parentId(String parentCaseInstanceId)

Description copied from interface: CaseInstanceBuilder

Set parent case instanceId of the newly create case instance

Specified by:

parentId in interface CaseInstanceBuilder

Parameters:

parentCaseInstanceId - parent case instance identifier

Returns:

modified case instance builder which creates case instance with the reference to parent

fallbackToDefaultTenant

public CaseInstanceBuilder fallbackToDefaultTenant()

Description copied from interface: CaseInstanceBuilder

If case definition is not found by key in the specified tenant use default tenant search as a fallback

Specified by:

fallbackToDefaultTenant in interface CaseInstanceBuilder

Returns:

modified case instance builder

start

public CaseInstance start()

Description copied from interface: CaseInstanceBuilder

Once all the information is set using this builder API, the start method will create the case instance, initialize it according all the data in the builder and then evaluate the case model to start the case. It will be initialized, evaluated and started in a single transaction, synchronously, so this method returns once the case model will hit a wait state.

Specified by:

start in interface CaseInstanceBuilder

Returns:

the case instance

startAsync

public CaseInstance startAsync()

Description copied from interface: CaseInstanceBuilder

Once all the information is set using this builder API, the startAsync method will create the case instance and initialize its data, but the case model is not yet evaluated, but will be started and evaluated asynchronously in a different transaction.

Specified by:

startAsync in interface CaseInstanceBuilder

Returns:

the case instance as being persisted, but not yet evaluated through the case model

startWithForm

public CaseInstance startWithForm()

Description copied from interface: CaseInstanceBuilder

Once all the information is set using this builder API, the startWithForm method will create the case instance and initialize its data by additionally using the submitted form variables and handling them with the start form provided with the case model (e.g. validation).

Specified by:

startWithForm in interface CaseInstanceBuilder

Returns:

the case instance as being persisted, but not yet evaluated through the case model

getCaseDefinitionId

public String getCaseDefinitionId()

Specified by:

getCaseDefinitionId in interface CaseInstanceBuilder

getCaseDefinitionKey

public String getCaseDefinitionKey()

Specified by:

getCaseDefinitionKey in interface CaseInstanceBuilder

getCaseDefinitionParentDeploymentId

public String getCaseDefinitionParentDeploymentId()

Specified by:

getCaseDefinitionParentDeploymentId in interface CaseInstanceBuilder

getPredefinedCaseInstanceId

public String getPredefinedCaseInstanceId()

Specified by:

getPredefinedCaseInstanceId in interface CaseInstanceBuilder

getName

public String getName()

Specified by:

getName in interface CaseInstanceBuilder

getBusinessKey

public String getBusinessKey()

Specified by:

getBusinessKey in interface CaseInstanceBuilder

getBusinessStatus

public String getBusinessStatus()

Specified by:

getBusinessStatus in interface CaseInstanceBuilder

getVariables

public Map<String,Object> getVariables()

Specified by:

getVariables in interface CaseInstanceBuilder

getTransientVariables

public Map<String,Object> getTransientVariables()

Specified by:

getTransientVariables in interface CaseInstanceBuilder

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface CaseInstanceBuilder

getOwner

public String getOwner()

Specified by:

getOwner in interface CaseInstanceBuilder

getAssignee

public String getAssignee()

Specified by:

getAssignee in interface CaseInstanceBuilder

getOverrideDefinitionTenantId

public String getOverrideDefinitionTenantId()

Specified by:

getOverrideDefinitionTenantId in interface CaseInstanceBuilder

getOutcome

public String getOutcome()

Specified by:

getOutcome in interface CaseInstanceBuilder

getStartFormVariables

public Map<String,Object> getStartFormVariables()

Specified by:

getStartFormVariables in interface CaseInstanceBuilder

getCallbackId

public String getCallbackId()

Specified by:

getCallbackId in interface CaseInstanceBuilder

getCallbackType

public String getCallbackType()

Specified by:

getCallbackType in interface CaseInstanceBuilder

getReferenceId

public String getReferenceId()

Specified by:

getReferenceId in interface CaseInstanceBuilder

getReferenceType

public String getReferenceType()

Specified by:

getReferenceType in interface CaseInstanceBuilder

getParentId

public String getParentId()

Specified by:

getParentId in interface CaseInstanceBuilder

isFallbackToDefaultTenant

public boolean isFallbackToDefaultTenant()

Specified by:

isFallbackToDefaultTenant in interface CaseInstanceBuilder

isStartWithForm

public boolean isStartWithForm()

Specified by:

isStartWithForm in interface CaseInstanceBuilder