Class CaseInstanceBuilderImpl
- All Implemented Interfaces:
CaseInstanceBuilder
- Author:
- Roman Smirnov
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected String
protected String
protected String
protected CommandContext
protected CommandExecutor
protected boolean
protected VariableMap
-
Constructor Summary
ConstructorDescriptionCaseInstanceBuilderImpl
(CommandContext commandContext, String caseDefinitionKey, String caseDefinitionId) CaseInstanceBuilderImpl
(CommandExecutor commandExecutor, String caseDefinitionKey, String caseDefinitionId) -
Method Summary
Modifier and TypeMethodDescriptionbusinessKey
(String businessKey) A business key can be provided to associate the case instance with a certain identifier that has a clear business meaning.caseDefinitionTenantId
(String tenantId) Specify the id of the tenant the case definition belongs to.Specify that the case definition belongs to no tenant.create()
Creates a newCaseInstance
, which will be in theACTIVE
state.boolean
setVariable
(String variableName, Object variableValue) Pass a variable to the case instance.setVariables
(Map<String, Object> variables) Pass a map of variables to the case instance.
-
Field Details
-
commandExecutor
-
commandContext
-
caseDefinitionKey
-
caseDefinitionId
-
businessKey
-
variables
-
caseDefinitionTenantId
-
isTenantIdSet
protected boolean isTenantIdSet
-
-
Constructor Details
-
CaseInstanceBuilderImpl
public CaseInstanceBuilderImpl(CommandExecutor commandExecutor, String caseDefinitionKey, String caseDefinitionId) -
CaseInstanceBuilderImpl
public CaseInstanceBuilderImpl(CommandContext commandContext, String caseDefinitionKey, String caseDefinitionId)
-
-
Method Details
-
businessKey
Description copied from interface:CaseInstanceBuilder
A business key can be provided to associate the case instance with a certain identifier that has a clear business meaning. This business key can then be used to easily look up that case instance, see
CaseInstanceQuery.caseInstanceBusinessKey(String)
. Providing such a business key is definitely a best practice.Note that a business key MUST be unique for the given case definition WHEN you have added a database constraint for it. In this case, only case instance from different case definition are allowed to have the same business key and the combination of caseDefinitionKey-businessKey must be unique.
- Specified by:
businessKey
in interfaceCaseInstanceBuilder
- Parameters:
businessKey
- a key that uniquely identifies the case instance in the context of the given case definition.- Returns:
- the builder
-
caseDefinitionTenantId
Description copied from interface:CaseInstanceBuilder
Specify the id of the tenant the case definition belongs to. Can only be used when the definition is referenced bykey
and not byid
.- Specified by:
caseDefinitionTenantId
in interfaceCaseInstanceBuilder
-
caseDefinitionWithoutTenantId
Description copied from interface:CaseInstanceBuilder
Specify that the case definition belongs to no tenant. Can only be used when the definition is referenced bykey
and not byid
.- Specified by:
caseDefinitionWithoutTenantId
in interfaceCaseInstanceBuilder
-
setVariable
Description copied from interface:CaseInstanceBuilder
Pass a variable to the case instance.
Invoking this method multiple times allows passing multiple variables.
- Specified by:
setVariable
in interfaceCaseInstanceBuilder
- Parameters:
variableName
- the name of the variable to setvariableValue
- the value of the variable to set- Returns:
- the builder
-
setVariables
Description copied from interface:CaseInstanceBuilder
Pass a map of variables to the case instance.
Invoking this method multiple times allows passing multiple variables.
- Specified by:
setVariables
in interfaceCaseInstanceBuilder
- Parameters:
variables
- the map of variables- Returns:
- the builder
-
create
Description copied from interface:CaseInstanceBuilder
Creates a new
CaseInstance
, which will be in theACTIVE
state.- Specified by:
create
in interfaceCaseInstanceBuilder
-
getCaseDefinitionKey
-
getCaseDefinitionId
-
getBusinessKey
-
getVariables
-
getCaseDefinitionTenantId
-
isTenantIdSet
public boolean isTenantIdSet()
-