Package org.camunda.bpm.engine.runtime
Interface VariableInstance
-
- All Known Subinterfaces:
DelegateCaseVariableInstance,DelegateVariableInstance<T>
- All Known Implementing Classes:
DelegateCaseVariableInstanceImpl,VariableInstanceEntity
public interface VariableInstanceAVariableInstancerepresents a variable in the execution of a process instance.- Author:
- roman.smirnov
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetActivityInstanceId()Returns the corresponding activity instance id.java.lang.StringgetBatchId()Returns the corresponding batch id.java.lang.StringgetCaseExecutionId()Returns the corresponding case execution id.java.lang.StringgetCaseInstanceId()Returns the corresponding case instance id.java.lang.StringgetErrorMessage()If the variable value could not be loaded, this returns the error message.java.lang.StringgetExecutionId()Returns the corresponding execution id.java.lang.StringgetId()java.lang.StringgetName()Returns the name of this variable instance.java.lang.StringgetProcessDefinitionId()Return the corresponding process definition id.java.lang.StringgetProcessInstanceId()Returns the corresponding process instance id.java.lang.StringgetTaskId()Returns the corresponding task id.java.lang.StringgetTenantId()The id of the tenant this variable belongs to.TypedValuegetTypedValue()Returns the TypedValue of this variable instance.java.lang.StringgetTypeName()Returns the name of the type of this variable instancejava.lang.ObjectgetValue()Returns the value of this variable instance.
-
-
-
Method Detail
-
getId
java.lang.String getId()
- Returns:
- the Id of this variable instance
-
getName
java.lang.String getName()
Returns the name of this variable instance.
-
getTypeName
java.lang.String getTypeName()
Returns the name of the type of this variable instance- Returns:
- the type name of the variable
-
getValue
java.lang.Object getValue()
Returns the value of this variable instance.
-
getTypedValue
TypedValue getTypedValue()
Returns the TypedValue of this variable instance.
-
getProcessInstanceId
java.lang.String getProcessInstanceId()
Returns the corresponding process instance id.
-
getExecutionId
java.lang.String getExecutionId()
Returns the corresponding execution id.
-
getProcessDefinitionId
java.lang.String getProcessDefinitionId()
Return the corresponding process definition id.
-
getCaseInstanceId
java.lang.String getCaseInstanceId()
Returns the corresponding case instance id.
-
getCaseExecutionId
java.lang.String getCaseExecutionId()
Returns the corresponding case execution id.
-
getTaskId
java.lang.String getTaskId()
Returns the corresponding task id.
-
getBatchId
java.lang.String getBatchId()
Returns the corresponding batch id.
-
getActivityInstanceId
java.lang.String getActivityInstanceId()
Returns the corresponding activity instance id.
-
getErrorMessage
java.lang.String getErrorMessage()
If the variable value could not be loaded, this returns the error message.- Returns:
- an error message indicating why the variable value could not be loaded.
-
getTenantId
java.lang.String getTenantId()
The id of the tenant this variable belongs to. Can benullif the variable belongs to no single tenant.
-
-