CaseInstanceBuilder (Flowable - CMMN API 6.7.2 API)

```
public interface CaseInstanceBuilder
```
Author:

Joram Barrez, Tijs Rademakers

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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)`
`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`	`getBusinessStatus()`
`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)`

- Method Detail
  - caseDefinitionId
```
CaseInstanceBuilder caseDefinitionId(String caseDefinitionId)
```
  - caseDefinitionKey
```
CaseInstanceBuilder caseDefinitionKey(String caseDefinitionKey)
```
  - caseDefinitionParentDeploymentId
```
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. 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
  - predefinedCaseInstanceId
```
CaseInstanceBuilder predefinedCaseInstanceId(String caseInstanceId)
```
  - name
```
CaseInstanceBuilder name(String name)
```
  - businessKey
```
CaseInstanceBuilder businessKey(String businessKey)
```
  - businessStatus
```
CaseInstanceBuilder businessStatus(String businessStatus)
```
  - variables
```
CaseInstanceBuilder variables(Map<String,Object> variables)
```
  - variable
```
CaseInstanceBuilder variable(String variableName,
                             Object value)
```
  - transientVariables
```
CaseInstanceBuilder transientVariables(Map<String,Object> transientVariables)
```
  - transientVariable
```
CaseInstanceBuilder transientVariable(String variableName,
                                      Object value)
```
  - tenantId
```
CaseInstanceBuilder tenantId(String tenantId)
```
  - overrideCaseDefinitionTenantId
```
CaseInstanceBuilder overrideCaseDefinitionTenantId(String tenantId)
```
    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.
  - startFormVariables
```
CaseInstanceBuilder startFormVariables(Map<String,Object> formVariables)
```
    Allows to pass any variables if they come from a form. The difference with regular variables(Map) is that the start form will be fetched and the variables matched with the FormInfo.
  - outcome
```
CaseInstanceBuilder outcome(String outcome)
```
  - callbackId
```
CaseInstanceBuilder callbackId(String callbackId)
```
    Set callback id of the newly created case instance.
    
    Parameters:
    
    callbackId - id of the callback
    
    Returns:
    
    case instance builder which creates case instance with defined callback id
  - callbackType
```
CaseInstanceBuilder callbackType(String callbackType)
```
    Set callback type of the newly created case instance.
    
    Parameters:
    
    callbackType - type of the callback
    
    Returns:
    
    case instance builder which creates case instance with defined callback type
  - referenceId
```
CaseInstanceBuilder referenceId(String referenceId)
```
    Set the reference id on the newly create case instance.
  - referenceType
```
CaseInstanceBuilder referenceType(String referenceType)
```
    Set the reference type on the newly create case instance.
  - parentId
```
CaseInstanceBuilder parentId(String parentCaseInstanceId)
```
    Set parent case instanceId of the newly create case instance
    
    Parameters:
    
    parentCaseInstanceId - parent case instance identifier
    
    Returns:
    
    modified case instance builder which creates case instance with the reference to parent
  - fallbackToDefaultTenant
```
CaseInstanceBuilder fallbackToDefaultTenant()
```
    If case definition is not found by key in the specified tenant use default tenant search as a fall back
    
    Returns:
    
    modified case instance builder
  - start
```
CaseInstance start()
```
  - startAsync
```
CaseInstance startAsync()
```
  - startWithForm
```
CaseInstance startWithForm()
```
  - getCaseDefinitionId
```
String getCaseDefinitionId()
```
  - getCaseDefinitionKey
```
String getCaseDefinitionKey()
```
  - getCaseDefinitionParentDeploymentId
```
String getCaseDefinitionParentDeploymentId()
```
  - getPredefinedCaseInstanceId
```
String getPredefinedCaseInstanceId()
```
  - getName
```
String getName()
```
  - getBusinessKey
```
String getBusinessKey()
```
  - getBusinessStatus
```
String getBusinessStatus()
```
  - getVariables
```
Map<String,Object> getVariables()
```
  - getTransientVariables
```
Map<String,Object> getTransientVariables()
```
  - getTenantId
```
String getTenantId()
```
  - getOverrideDefinitionTenantId
```
String getOverrideDefinitionTenantId()
```
  - getStartFormVariables
```
Map<String,Object> getStartFormVariables()
```
  - getOutcome
```
String getOutcome()
```
  - getCallbackId
```
String getCallbackId()
```
  - getCallbackType
```
String getCallbackType()
```
  - getReferenceId
```
String getReferenceId()
```
  - getReferenceType
```
String getReferenceType()
```
  - getParentId
```
String getParentId()
```
  - isFallbackToDefaultTenant
```
boolean isFallbackToDefaultTenant()
```
  - isStartWithForm
```
boolean isStartWithForm()
```

Interface CaseInstanceBuilder

Method Summary

Method Detail

caseDefinitionId

caseDefinitionKey

caseDefinitionParentDeploymentId

predefinedCaseInstanceId

name

businessKey

businessStatus

variables

variable

transientVariables

transientVariable

tenantId

overrideCaseDefinitionTenantId

startFormVariables

outcome

callbackId

callbackType

referenceId

referenceType

parentId

fallbackToDefaultTenant

start

startAsync

startWithForm

getCaseDefinitionId

getCaseDefinitionKey

getCaseDefinitionParentDeploymentId

getPredefinedCaseInstanceId

getName

getBusinessKey

getBusinessStatus

getVariables

getTransientVariables

getTenantId

getOverrideDefinitionTenantId

getStartFormVariables

getOutcome

getCallbackId

getCallbackType

getReferenceId

getReferenceType

getParentId

isFallbackToDefaultTenant

isStartWithForm