CaseInstanceBuilderImpl (Flowable 6.7.0 API)

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 and Description
`protected String`	`businessKey`
`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`	`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 and Description

CaseInstanceBuilderImpl()

CaseInstanceBuilderImpl(CmmnRuntimeServiceImpl cmmnRuntimeService)

Constructors
Constructor and Description
`CaseInstanceBuilderImpl()`
`CaseInstanceBuilderImpl(CmmnRuntimeServiceImpl cmmnRuntimeService)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CaseInstanceBuilder`	`businessKey(String businessKey)`
`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)`
`CaseInstanceBuilder`	`caseDefinitionKey(String caseDefinitionKey)`
`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 fall back
`String`	`getBusinessKey()`
`String`	`getCallbackId()`
`String`	`getCallbackType()`
`String`	`getCaseDefinitionId()`
`String`	`getCaseDefinitionKey()`
`String`	`getCaseDefinitionParentDeploymentId()`
`String`	`getName()`
`String`	`getOutcome()`
`String`	`getOverrideDefinitionTenantId()`
`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)`
`CaseInstanceBuilder`	`overrideCaseDefinitionTenantId(String tenantId)` Indicator to override the tenant id of the case definition with the provided value.
`CaseInstanceBuilder`	`parentId(String parentCaseInstanceId)` Set parent case instanceId of the newly create case instance
`CaseInstanceBuilder`	`predefinedCaseInstanceId(String caseInstanceId)`
`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()`
`CaseInstance`	`startAsync()`
`CaseInstanceBuilder`	`startFormVariables(Map<String,Object> formVariables)` Allows to pass any variables if they come from a form.
`CaseInstance`	`startWithForm()`
`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 Detail
  - 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
```
  - variables
```
protected Map<String,Object> variables
```
  - transientVariables
```
protected Map<String,Object> transientVariables
```
  - tenantId
```
protected String tenantId
```
  - 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 Detail
  - CaseInstanceBuilderImpl
```
public CaseInstanceBuilderImpl()
```
  - CaseInstanceBuilderImpl
```
public CaseInstanceBuilderImpl(CmmnRuntimeServiceImpl cmmnRuntimeService)
```
- Method Detail
  - caseDefinitionId
```
public CaseInstanceBuilder caseDefinitionId(String caseDefinitionId)
```
    Specified by:
    
    caseDefinitionId in interface CaseInstanceBuilder
  - caseDefinitionKey
```
public CaseInstanceBuilder caseDefinitionKey(String caseDefinitionKey)
```
    Specified by:
    
    caseDefinitionKey in interface CaseInstanceBuilder
  - 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 look up 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)
```
    Specified by:
    
    predefinedCaseInstanceId in interface CaseInstanceBuilder
  - name
```
public CaseInstanceBuilder name(String name)
```
    Specified by:
    
    name in interface CaseInstanceBuilder
  - businessKey
```
public CaseInstanceBuilder businessKey(String businessKey)
```
    Specified by:
    
    businessKey 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
  - 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)
```
    Specified by:
    
    outcome in interface CaseInstanceBuilder
  - 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 fall back
    
    Specified by:
    
    fallbackToDefaultTenant in interface CaseInstanceBuilder
    
    Returns:
    
    modified case instance builder
  - start
```
public CaseInstance start()
```
    Specified by:
    
    start in interface CaseInstanceBuilder
  - startAsync
```
public CaseInstance startAsync()
```
    Specified by:
    
    startAsync in interface CaseInstanceBuilder
  - startWithForm
```
public CaseInstance startWithForm()
```
    Specified by:
    
    startWithForm in interface CaseInstanceBuilder
  - 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
  - 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
  - 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

Class CaseInstanceBuilderImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cmmnRuntimeService

caseDefinitionId

caseDefinitionKey

caseDefinitionParentDeploymentId

predefinedCaseInstanceId

name

businessKey

variables

transientVariables

tenantId

overrideDefinitionTenantId

outcome

startFormVariables

callbackType

callbackId

referenceId

referenceType

parentId

fallbackToDefaultTenant

startWithForm

Constructor Detail

CaseInstanceBuilderImpl

CaseInstanceBuilderImpl

Method Detail

caseDefinitionId

caseDefinitionKey

caseDefinitionParentDeploymentId

predefinedCaseInstanceId

name

businessKey

variables

variable

transientVariables

transientVariable

tenantId

overrideCaseDefinitionTenantId

outcome

startFormVariables

callbackId

callbackType

referenceId

referenceType

parentId

fallbackToDefaultTenant

start

startAsync

startWithForm

getCaseDefinitionId

getCaseDefinitionKey

getCaseDefinitionParentDeploymentId

getPredefinedCaseInstanceId

getName

getBusinessKey

getVariables

getTransientVariables

getTenantId

getOverrideDefinitionTenantId

getOutcome

getStartFormVariables

getCallbackId

getCallbackType

getReferenceId

getReferenceType

getParentId

isFallbackToDefaultTenant

isStartWithForm