org.camunda.bpm.engine.delegate

Interface VariableScope

All Known Subinterfaces:

ActivityExecution, BaseDelegateExecution, CmmnActivityExecution, CmmnCaseInstance, DelegateCaseExecution, DelegateExecution, DelegateTask

All Known Implementing Classes:

AbstractVariableScope, CaseExecutionEntity, CaseExecutionImpl, CmmnExecution, ConnectorVariableScope, CoreExecution, ExecutionEntity, ExecutionImpl, PvmExecutionImpl, StartProcessVariableScope, TaskEntity, VariableScopeLocalAdapter

public interface VariableScope

Author:

Tom Baeyens

Method Summary

Methods

Modifier and Type	Method and Description
Object	getVariable(String variableName)
Object	getVariableLocal(String variableName)
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getVariableLocalTyped(String variableName)
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getVariableLocalTyped(String variableName, boolean deserializeValue)
Set<String>	getVariableNames()
Set<String>	getVariableNamesLocal()
Map<String,Object>	getVariables()
String	getVariableScopeKey()
Map<String,Object>	getVariablesLocal()
org.camunda.bpm.engine.variable.VariableMap	getVariablesLocalTyped()
org.camunda.bpm.engine.variable.VariableMap	getVariablesLocalTyped(boolean deserializeValues)
org.camunda.bpm.engine.variable.VariableMap	getVariablesTyped()
org.camunda.bpm.engine.variable.VariableMap	getVariablesTyped(boolean deserializeValues)
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getVariableTyped(String variableName)
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getVariableTyped(String variableName, boolean deserializeValue)
boolean	hasVariable(String variableName)
boolean	hasVariableLocal(String variableName)
boolean	hasVariables()
boolean	hasVariablesLocal()
void	removeVariable(String variableName) Removes the variable and creates a new HistoricVariableUpdateEntity.
void	removeVariableLocal(String variableName) Removes the local variable and creates a new HistoricVariableUpdateEntity.
void	removeVariables() Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariables(Collection<String> variableNames) Removes the variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariablesLocal() Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariablesLocal(Collection<String> variableNames) Removes the local variables and creates a new HistoricVariableUpdateEntity for each of them.
void	setVariable(String variableName, Object value)
void	setVariableLocal(String variableName, Object value)
void	setVariables(Map<String,? extends Object> variables)
void	setVariablesLocal(Map<String,? extends Object> variables)

Method Detail

getVariableScopeKey

String getVariableScopeKey()

getVariables

Map<String,Object> getVariables()

getVariablesTyped

org.camunda.bpm.engine.variable.VariableMap getVariablesTyped()

getVariablesTyped

org.camunda.bpm.engine.variable.VariableMap getVariablesTyped(boolean deserializeValues)

getVariablesLocal

Map<String,Object> getVariablesLocal()

getVariablesLocalTyped

org.camunda.bpm.engine.variable.VariableMap getVariablesLocalTyped()

getVariablesLocalTyped

org.camunda.bpm.engine.variable.VariableMap getVariablesLocalTyped(boolean deserializeValues)

getVariable

Object getVariable(String variableName)

getVariableLocal

Object getVariableLocal(String variableName)

getVariableTyped

<T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableTyped(String variableName)

getVariableTyped

<T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableTyped(String variableName,
                                                                              boolean deserializeValue)

getVariableLocalTyped

<T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableLocalTyped(String variableName)

getVariableLocalTyped

<T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableLocalTyped(String variableName,
                                                                                   boolean deserializeValue)

getVariableNames

Set<String> getVariableNames()

getVariableNamesLocal

Set<String> getVariableNamesLocal()

setVariable

void setVariable(String variableName,
               Object value)

setVariableLocal

void setVariableLocal(String variableName,
                    Object value)

setVariables

void setVariables(Map<String,? extends Object> variables)

setVariablesLocal

void setVariablesLocal(Map<String,? extends Object> variables)

hasVariables

boolean hasVariables()

hasVariablesLocal

boolean hasVariablesLocal()

hasVariable

boolean hasVariable(String variableName)

hasVariableLocal

boolean hasVariableLocal(String variableName)

removeVariable

void removeVariable(String variableName)

Removes the variable and creates a new HistoricVariableUpdateEntity.

removeVariableLocal

void removeVariableLocal(String variableName)

Removes the local variable and creates a new HistoricVariableUpdateEntity.

removeVariables

void removeVariables(Collection<String> variableNames)

Removes the variables and creates a new HistoricVariableUpdateEntity for each of them.

removeVariablesLocal

void removeVariablesLocal(Collection<String> variableNames)

Removes the local variables and creates a new HistoricVariableUpdateEntity for each of them.

removeVariables

void removeVariables()

Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.

removeVariablesLocal

void removeVariablesLocal()

Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.