Package 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

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

Method Detail

getVariableScopeKey

java.lang.String getVariableScopeKey()

getVariables

java.util.Map<java.lang.String,java.lang.Object> getVariables()

getVariablesTyped

VariableMap getVariablesTyped()

getVariablesTyped

VariableMap getVariablesTyped(boolean deserializeValues)

getVariablesLocal

java.util.Map<java.lang.String,java.lang.Object> getVariablesLocal()

getVariablesLocalTyped

VariableMap getVariablesLocalTyped()

getVariablesLocalTyped

VariableMap getVariablesLocalTyped(boolean deserializeValues)

getVariable

java.lang.Object getVariable(java.lang.String variableName)

getVariableLocal

java.lang.Object getVariableLocal(java.lang.String variableName)

getVariableTyped

<T extends TypedValue> T getVariableTyped(java.lang.String variableName)

getVariableTyped

<T extends TypedValue> T getVariableTyped(java.lang.String variableName,
                                          boolean deserializeValue)

getVariableLocalTyped

<T extends TypedValue> T getVariableLocalTyped(java.lang.String variableName)

getVariableLocalTyped

<T extends TypedValue> T getVariableLocalTyped(java.lang.String variableName,
                                               boolean deserializeValue)

getVariableNames

java.util.Set<java.lang.String> getVariableNames()

getVariableNamesLocal

java.util.Set<java.lang.String> getVariableNamesLocal()

setVariable

void setVariable(java.lang.String variableName,
                 java.lang.Object value)

setVariableLocal

void setVariableLocal(java.lang.String variableName,
                      java.lang.Object value)

setVariables

void setVariables(java.util.Map<java.lang.String,? extends java.lang.Object> variables)

setVariablesLocal

void setVariablesLocal(java.util.Map<java.lang.String,? extends java.lang.Object> variables)

hasVariables

boolean hasVariables()

hasVariablesLocal

boolean hasVariablesLocal()

hasVariable

boolean hasVariable(java.lang.String variableName)

hasVariableLocal

boolean hasVariableLocal(java.lang.String variableName)

removeVariable

void removeVariable(java.lang.String variableName)

Removes the variable and creates a new HistoricVariableUpdateEntity.

removeVariableLocal

void removeVariableLocal(java.lang.String variableName)

Removes the local variable and creates a new HistoricVariableUpdateEntity.

removeVariables

void removeVariables(java.util.Collection<java.lang.String> variableNames)

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

removeVariablesLocal

void removeVariablesLocal(java.util.Collection<java.lang.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.