Class DelegateCaseVariableInstanceImpl
- java.lang.Object
-
- org.camunda.bpm.engine.impl.variable.listener.DelegateCaseVariableInstanceImpl
-
- All Implemented Interfaces:
DelegateCaseVariableInstance
,DelegateVariableInstance<DelegateCaseExecution>
,ProcessEngineServicesAware
,VariableInstance
public class DelegateCaseVariableInstanceImpl extends Object implements DelegateCaseVariableInstance
- Author:
- Thorben Lindhauer
-
-
Field Summary
Fields Modifier and Type Field Description protected String
activityInstanceId
protected String
caseExecutionId
protected String
caseInstanceId
protected String
errorMessage
protected String
eventName
protected String
executionId
protected String
name
protected String
processDefinitionId
protected String
processInstanceId
protected DelegateCaseExecution
scopeExecution
protected DelegateCaseExecution
sourceExecution
protected String
taskId
protected String
tenantId
protected TypedValue
value
protected String
variableId
-
Constructor Summary
Constructors Constructor Description DelegateCaseVariableInstanceImpl()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DelegateCaseVariableInstanceImpl
fromVariableInstance(VariableInstance variableInstance)
String
getActivityInstanceId()
Returns the corresponding activity instance id.String
getBatchId()
Returns the corresponding batch id.String
getCaseExecutionId()
Returns the corresponding case execution id.String
getCaseInstanceId()
Returns the corresponding case instance id.String
getErrorMessage()
If the variable value could not be loaded, this returns the error message.String
getEventName()
The event name, which caused the listener to be notified.String
getExecutionId()
Returns the corresponding execution id.String
getId()
String
getName()
Returns the name of this variable instance.String
getProcessDefinitionId()
Return the corresponding process definition id.ProcessEngine
getProcessEngine()
Returns theProcessEngine
providing access to the public API of the process engine.ProcessEngineServices
getProcessEngineServices()
Returns theProcessEngineServices
providing access to the public API of the process engine.String
getProcessInstanceId()
Returns the corresponding process instance id.DelegateCaseExecution
getScopeExecution()
Currently not part of public interface.DelegateCaseExecution
getSourceExecution()
The case execution in which context the variable was created/updated/deleted.String
getTaskId()
Returns the corresponding task id.String
getTenantId()
The id of the tenant this variable belongs to.TypedValue
getTypedValue()
Returns the TypedValue of this variable instance.String
getTypeName()
Returns the name of the type of this variable instanceObject
getValue()
Returns the value of this variable instance.void
setEventName(String eventName)
void
setScopeExecution(DelegateCaseExecution scopeExecution)
void
setSourceExecution(DelegateCaseExecution sourceExecution)
void
setTenantId(String tenantId)
-
-
-
Field Detail
-
eventName
protected String eventName
-
sourceExecution
protected DelegateCaseExecution sourceExecution
-
scopeExecution
protected DelegateCaseExecution scopeExecution
-
variableId
protected String variableId
-
processDefinitionId
protected String processDefinitionId
-
processInstanceId
protected String processInstanceId
-
executionId
protected String executionId
-
caseInstanceId
protected String caseInstanceId
-
caseExecutionId
protected String caseExecutionId
-
taskId
protected String taskId
-
activityInstanceId
protected String activityInstanceId
-
tenantId
protected String tenantId
-
errorMessage
protected String errorMessage
-
name
protected String name
-
value
protected TypedValue value
-
-
Method Detail
-
getEventName
public String getEventName()
Description copied from interface:DelegateCaseVariableInstance
The event name, which caused the listener to be notified. Valid values are the constants defined inCaseVariableListener
.- Specified by:
getEventName
in interfaceDelegateCaseVariableInstance
- Specified by:
getEventName
in interfaceDelegateVariableInstance<DelegateCaseExecution>
-
setEventName
public void setEventName(String eventName)
-
getSourceExecution
public DelegateCaseExecution getSourceExecution()
Description copied from interface:DelegateCaseVariableInstance
The case execution in which context the variable was created/updated/deleted.- Specified by:
getSourceExecution
in interfaceDelegateCaseVariableInstance
- Specified by:
getSourceExecution
in interfaceDelegateVariableInstance<DelegateCaseExecution>
-
setSourceExecution
public void setSourceExecution(DelegateCaseExecution sourceExecution)
-
getScopeExecution
public DelegateCaseExecution getScopeExecution()
Currently not part of public interface.
-
setScopeExecution
public void setScopeExecution(DelegateCaseExecution scopeExecution)
-
getId
public String getId()
- Specified by:
getId
in interfaceVariableInstance
- Returns:
- the Id of this variable instance
-
getProcessDefinitionId
public String getProcessDefinitionId()
Description copied from interface:VariableInstance
Return the corresponding process definition id.- Specified by:
getProcessDefinitionId
in interfaceVariableInstance
-
getProcessInstanceId
public String getProcessInstanceId()
Description copied from interface:VariableInstance
Returns the corresponding process instance id.- Specified by:
getProcessInstanceId
in interfaceVariableInstance
-
getExecutionId
public String getExecutionId()
Description copied from interface:VariableInstance
Returns the corresponding execution id.- Specified by:
getExecutionId
in interfaceVariableInstance
-
getCaseInstanceId
public String getCaseInstanceId()
Description copied from interface:VariableInstance
Returns the corresponding case instance id.- Specified by:
getCaseInstanceId
in interfaceVariableInstance
-
getCaseExecutionId
public String getCaseExecutionId()
Description copied from interface:VariableInstance
Returns the corresponding case execution id.- Specified by:
getCaseExecutionId
in interfaceVariableInstance
-
getTaskId
public String getTaskId()
Description copied from interface:VariableInstance
Returns the corresponding task id.- Specified by:
getTaskId
in interfaceVariableInstance
-
getBatchId
public String getBatchId()
Description copied from interface:VariableInstance
Returns the corresponding batch id.- Specified by:
getBatchId
in interfaceVariableInstance
-
getActivityInstanceId
public String getActivityInstanceId()
Description copied from interface:VariableInstance
Returns the corresponding activity instance id.- Specified by:
getActivityInstanceId
in interfaceVariableInstance
-
getErrorMessage
public String getErrorMessage()
Description copied from interface:VariableInstance
If the variable value could not be loaded, this returns the error message.- Specified by:
getErrorMessage
in interfaceVariableInstance
- Returns:
- an error message indicating why the variable value could not be loaded.
-
getTenantId
public String getTenantId()
Description copied from interface:VariableInstance
The id of the tenant this variable belongs to. Can benull
if the variable belongs to no single tenant.- Specified by:
getTenantId
in interfaceVariableInstance
-
setTenantId
public void setTenantId(String tenantId)
-
getTypeName
public String getTypeName()
Description copied from interface:VariableInstance
Returns the name of the type of this variable instance- Specified by:
getTypeName
in interfaceVariableInstance
- Returns:
- the type name of the variable
-
getName
public String getName()
Description copied from interface:VariableInstance
Returns the name of this variable instance.- Specified by:
getName
in interfaceVariableInstance
-
getValue
public Object getValue()
Description copied from interface:VariableInstance
Returns the value of this variable instance.- Specified by:
getValue
in interfaceVariableInstance
-
getTypedValue
public TypedValue getTypedValue()
Description copied from interface:VariableInstance
Returns the TypedValue of this variable instance.- Specified by:
getTypedValue
in interfaceVariableInstance
-
getProcessEngineServices
public ProcessEngineServices getProcessEngineServices()
Description copied from interface:ProcessEngineServicesAware
Returns theProcessEngineServices
providing access to the public API of the process engine.- Specified by:
getProcessEngineServices
in interfaceProcessEngineServicesAware
- Returns:
- the
ProcessEngineServices
.
-
getProcessEngine
public ProcessEngine getProcessEngine()
Description copied from interface:ProcessEngineServicesAware
Returns theProcessEngine
providing access to the public API of the process engine.- Specified by:
getProcessEngine
in interfaceProcessEngineServicesAware
- Returns:
- the
ProcessEngine
.
-
fromVariableInstance
public static DelegateCaseVariableInstanceImpl fromVariableInstance(VariableInstance variableInstance)
-
-