org.flowable.variable.service

Interface VariableService

All Known Implementing Classes:

VariableServiceImpl

public interface VariableService

Service which provides access to variables.

Author:

Tijs Rademakers, Joram Barrez

Method Summary

Modifier and Type	Method and Description
InternalVariableInstanceQuery	createInternalVariableInstanceQuery()
VariableInstanceEntity	createVariableInstance(String name, VariableType type) Create a variable instance without setting the value on it.
VariableInstanceEntity	createVariableInstance(String name, VariableType type, Object value)
void	deleteVariableInstance(VariableInstanceEntity variable)
void	deleteVariablesByExecutionId(String executionId)
void	deleteVariablesByTaskId(String taskId)
default List<VariableInstanceEntity>	findVariableInstanceByScopeIdAndScopeType(String scopeId, String scopeType)
default List<VariableInstanceEntity>	findVariableInstanceBySubScopeIdAndScopeType(String subScopeId, String scopeType)
default List<VariableInstanceEntity>	findVariableInstancesByExecutionId(String executionId)
void	insertVariableInstance(VariableInstanceEntity variable)
void	updateVariableInstance(VariableInstanceEntity variable) Updates variable instance with the new value

Method Detail

createInternalVariableInstanceQuery

InternalVariableInstanceQuery createInternalVariableInstanceQuery()

findVariableInstancesByExecutionId

default List<VariableInstanceEntity> findVariableInstancesByExecutionId(String executionId)

findVariableInstanceByScopeIdAndScopeType

default List<VariableInstanceEntity> findVariableInstanceByScopeIdAndScopeType(String scopeId,
                                                                               String scopeType)

findVariableInstanceBySubScopeIdAndScopeType

default List<VariableInstanceEntity> findVariableInstanceBySubScopeIdAndScopeType(String subScopeId,
                                                                                  String scopeType)

createVariableInstance

VariableInstanceEntity createVariableInstance(String name,
                                              VariableType type,
                                              Object value)

createVariableInstance

VariableInstanceEntity createVariableInstance(String name,
                                              VariableType type)

Create a variable instance without setting the value on it. IMPORTANT: If you use this method you would have to call VariableInstance.setValue(Object) for setting the value

Parameters:

name - the name of the variable to create

type - the type of the created variable

Returns:

the VariableInstanceEntity to be used

insertVariableInstance

void insertVariableInstance(VariableInstanceEntity variable)

updateVariableInstance

void updateVariableInstance(VariableInstanceEntity variable)

Updates variable instance with the new value

Parameters:

variable - to update

deleteVariableInstance

void deleteVariableInstance(VariableInstanceEntity variable)

deleteVariablesByExecutionId

void deleteVariablesByExecutionId(String executionId)

deleteVariablesByTaskId

void deleteVariablesByTaskId(String taskId)