Uses of Interface
org.flowable.variable.api.persistence.entity.VariableInstance
Packages that use VariableInstance
Package
Description
Public API of the Flowable engine.
Typical usage of the API starts by the creation of a
Through the services obtained from such a
Typical usage of the API starts by the creation of a
ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine
can be obtained.Through the services obtained from such a
ProcessEngine
, BPM and workflow operation
can be executed:RepositoryService
: Manages Deployment
s.RuntimeService
: For starting and searching ProcessInstance
s.TaskService
: Exposes operations to manage human (standalone) tasks, such as claiming, completing and assigning tasks.IdentityService
: Used for managing users, groups and the relations between them.ManagementService
: Exposes engine administration and maintenance operations,
which have no relation to the runtime exection of business processes.HistoryService
: Exposes information about ongoing and past process instances.FormService
: Access to form data and rendered forms for starting new process instances and completing tasks.API implementation classes, which shouldn't directly be used by end-users.
-
Uses of VariableInstance in org.flowable.cmmn.api
Methods in org.flowable.cmmn.api that return VariableInstanceModifier and TypeMethodDescriptionCmmnRuntimeService.getLocalVariableInstance
(String planItemInstanceId, String variableName) The local variable.CmmnRuntimeService.getVariableInstance
(String caseInstanceId, String variableName) The variable.CmmnTaskService.getVariableInstance
(String taskId, String variableName) The variable.CmmnTaskService.getVariableInstanceLocal
(String taskId, String variableName) The variable for a task.Methods in org.flowable.cmmn.api that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionCmmnRuntimeService.getLocalVariableInstances
(String planItemInstanceId) All variable values that are defined in the plan item instance scope, without taking outer scopes into account.CmmnRuntimeService.getVariableInstances
(String caseInstanceId) All variables visible from the given case instance scope.CmmnTaskService.getVariableInstances
(String taskId) All variables visible from the given task scope (including parent scopes).CmmnTaskService.getVariableInstances
(String taskId, Collection<String> variableNames) The variable values for all given variableNames, takes all variables into account which are visible from the given task scope (including parent scopes).CmmnTaskService.getVariableInstancesLocal
(String taskId) All variable values that are defined in the task scope, without taking outer scopes into account.CmmnTaskService.getVariableInstancesLocal
(String taskId, Collection<String> variableNames) The variable values for all given variableNames that are defined in the given task's scope.CmmnTaskService.getVariableInstancesLocalByTaskIds
(Set<String> taskIds) get all variables and search only in the task scope. -
Uses of VariableInstance in org.flowable.cmmn.api.delegate
Method parameters in org.flowable.cmmn.api.delegate with type arguments of type VariableInstanceModifier and TypeMethodDescriptionPlanItemVariableAggregator.aggregateMultiVariables
(DelegatePlanItemInstance planItemInstance, List<? extends VariableInstance> instances, PlanItemVariableAggregatorContext context) Aggregated the provided variable instances into one variable value. -
Uses of VariableInstance in org.flowable.cmmn.engine.impl
Methods in org.flowable.cmmn.engine.impl that return VariableInstanceModifier and TypeMethodDescriptionCmmnTaskServiceImpl.getVariableInstance
(String taskId, String variableName) CmmnTaskServiceImpl.getVariableInstanceLocal
(String taskId, String variableName) Methods in org.flowable.cmmn.engine.impl that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionCmmnTaskServiceImpl.getVariableInstances
(String taskId) CmmnTaskServiceImpl.getVariableInstances
(String taskId, Collection<String> variableNames) CmmnTaskServiceImpl.getVariableInstancesLocal
(String taskId) CmmnTaskServiceImpl.getVariableInstancesLocal
(String taskId, Collection<String> variableNames) CmmnTaskServiceImpl.getVariableInstancesLocalByTaskIds
(Set<String> taskIds) -
Uses of VariableInstance in org.flowable.cmmn.engine.impl.cmd
Methods in org.flowable.cmmn.engine.impl.cmd that return VariableInstanceModifier and TypeMethodDescriptionGetCaseVariableInstanceCmd.execute
(CommandContext commandContext) GetPlanItemVariableInstanceCmd.execute
(CommandContext commandContext) GetTaskVariableInstanceCmd.execute
(CommandContext commandContext) Methods in org.flowable.cmmn.engine.impl.cmd that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionGetCaseVariableInstancesCmd.execute
(CommandContext commandContext) GetPlanItemVariableInstancesCmd.execute
(CommandContext commandContext) GetTasksLocalVariablesCmd.execute
(CommandContext commandContext) GetTaskVariableInstancesCmd.execute
(CommandContext commandContext) -
Uses of VariableInstance in org.flowable.cmmn.engine.impl.delegate
Method parameters in org.flowable.cmmn.engine.impl.delegate with type arguments of type VariableInstanceModifier and TypeMethodDescriptionCmmnClassDelegate.aggregateMultiVariables
(DelegatePlanItemInstance planItemInstance, List<? extends VariableInstance> instances, PlanItemVariableAggregatorContext context) JsonPlanItemVariableAggregator.aggregateMultiVariables
(DelegatePlanItemInstance planItemInstance, List<? extends VariableInstance> instances, PlanItemVariableAggregatorContext context) -
Uses of VariableInstance in org.flowable.cmmn.engine.impl.persistence.entity
Methods in org.flowable.cmmn.engine.impl.persistence.entity with parameters of type VariableInstanceModifier and TypeMethodDescriptionprotected void
CaseInstanceEntityImpl.initializeVariableInstanceBackPointer
(VariableInstance variableInstance) protected void
PlanItemInstanceEntityImpl.initializeVariableInstanceBackPointer
(VariableInstance variableInstance) -
Uses of VariableInstance in org.flowable.cmmn.engine.impl.runtime
Methods in org.flowable.cmmn.engine.impl.runtime that return VariableInstanceModifier and TypeMethodDescriptionCmmnRuntimeServiceImpl.getLocalVariableInstance
(String planItemInstanceId, String variableName) CmmnRuntimeServiceImpl.getVariableInstance
(String caseInstanceId, String variableName) CmmnVariableInstanceQueryImpl.singleResult()
Methods in org.flowable.cmmn.engine.impl.runtime that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionCmmnRuntimeServiceImpl.getLocalVariableInstances
(String planItemInstanceId) CmmnRuntimeServiceImpl.getVariableInstances
(String caseInstanceId) CmmnVariableInstanceQueryImpl.list()
CmmnVariableInstanceQueryImpl.listPage
(int firstResult, int maxResults) -
Uses of VariableInstance in org.flowable.cmmn.engine.impl.variable
Methods in org.flowable.cmmn.engine.impl.variable that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionstatic Map<String,
List<VariableInstance>> CmmnAggregation.groupVariableInstancesByName
(List<? extends VariableInstance> instances) Method parameters in org.flowable.cmmn.engine.impl.variable with type arguments of type VariableInstanceModifier and TypeMethodDescriptionstatic Map<String,
List<VariableInstance>> CmmnAggregation.groupVariableInstancesByName
(List<? extends VariableInstance> instances) static void
CmmnAggregation.sortVariablesByCounter
(List<VariableInstance> variableInstances, List<VariableInstance> counterVariableInstances) -
Uses of VariableInstance in org.flowable.cmmn.rest.service.api
Methods in org.flowable.cmmn.rest.service.api with parameters of type VariableInstanceModifier and TypeMethodDescriptionvoid
CmmnRestApiInterceptor.accessVariableInfoById
(VariableInstance variableInstance) CmmnRestResponseFactory.createVariableInstanceResponse
(VariableInstance variableInstance) CmmnRestResponseFactory.createVariableInstanceResponse
(VariableInstance variableInstance, RestUrlBuilder urlBuilder) Method parameters in org.flowable.cmmn.rest.service.api with type arguments of type VariableInstanceModifier and TypeMethodDescriptionCmmnRestResponseFactory.createVariableInstanceResponseList
(List<VariableInstance> variableInstances) -
Uses of VariableInstance in org.flowable.engine
Methods in org.flowable.engine that return VariableInstanceModifier and TypeMethodDescriptionRuntimeService.getVariableInstance
(String executionId, String variableName) The variable.TaskService.getVariableInstance
(String taskId, String variableName) The variable.RuntimeService.getVariableInstanceLocal
(String executionId, String variableName) The variable for an execution.TaskService.getVariableInstanceLocal
(String taskId, String variableName) The variable for a task.Methods in org.flowable.engine that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionRuntimeService.getVariableInstances
(String executionId) All variables visible from the given execution scope (including parent scopes).RuntimeService.getVariableInstances
(String executionId, Collection<String> variableNames) The variable values for all given variableNames, takes all variables into account which are visible from the given execution scope (including parent scopes).TaskService.getVariableInstances
(String taskId) All variables visible from the given task scope (including parent scopes).TaskService.getVariableInstances
(String taskId, Collection<String> variableNames) The variable values for all given variableNames, takes all variables into account which are visible from the given task scope (including parent scopes).RuntimeService.getVariableInstancesByExecutionIds
(Set<String> executionIds) All variables visible from the given execution scope (including parent scopes).RuntimeService.getVariableInstancesLocal
(String executionId) All variable values that are defined in the execution scope, without taking outer scopes into account.RuntimeService.getVariableInstancesLocal
(String executionId, Collection<String> variableNames) The variable values for the given variableNames only taking the given execution scope into account, not looking in outer scopes.TaskService.getVariableInstancesLocal
(String taskId) All variable values that are defined in the task scope, without taking outer scopes into account.TaskService.getVariableInstancesLocal
(String taskId, Collection<String> variableNames) The variable values for all given variableNames that are defined in the given task's scope.TaskService.getVariableInstancesLocalByTaskIds
(Set<String> taskIds) get all variables and search only in the task scope. -
Uses of VariableInstance in org.flowable.engine.compatibility
Methods in org.flowable.engine.compatibility that return VariableInstanceModifier and TypeMethodDescriptionFlowable5CompatibilityHandler.getExecutionVariableInstance
(String executionId, String variableName, boolean isLocal) Methods in org.flowable.engine.compatibility that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionFlowable5CompatibilityHandler.getExecutionVariableInstances
(String executionId, Collection<String> variableNames, boolean isLocal) -
Uses of VariableInstance in org.flowable.engine.delegate.variable
Method parameters in org.flowable.engine.delegate.variable with type arguments of type VariableInstanceModifier and TypeMethodDescriptionVariableAggregator.aggregateMultiVariables
(DelegateExecution execution, List<? extends VariableInstance> instances, VariableAggregatorContext context) Aggregated the provided variable instances into one variable value. -
Uses of VariableInstance in org.flowable.engine.impl
Methods in org.flowable.engine.impl that return VariableInstanceModifier and TypeMethodDescriptionRuntimeServiceImpl.getVariableInstance
(String executionId, String variableName) TaskServiceImpl.getVariableInstance
(String taskId, String variableName) RuntimeServiceImpl.getVariableInstanceLocal
(String executionId, String variableName) TaskServiceImpl.getVariableInstanceLocal
(String taskId, String variableName) Methods in org.flowable.engine.impl that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionRuntimeServiceImpl.getVariableInstances
(String executionId) RuntimeServiceImpl.getVariableInstances
(String executionId, Collection<String> variableNames) TaskServiceImpl.getVariableInstances
(String taskId) TaskServiceImpl.getVariableInstances
(String taskId, Collection<String> variableNames) RuntimeServiceImpl.getVariableInstancesByExecutionIds
(Set<String> executionIds) RuntimeServiceImpl.getVariableInstancesLocal
(String executionId) RuntimeServiceImpl.getVariableInstancesLocal
(String executionId, Collection<String> variableNames) TaskServiceImpl.getVariableInstancesLocal
(String taskId) TaskServiceImpl.getVariableInstancesLocal
(String taskId, Collection<String> variableNames) TaskServiceImpl.getVariableInstancesLocalByTaskIds
(Set<String> taskIds) -
Uses of VariableInstance in org.flowable.engine.impl.bpmn.behavior
Methods in org.flowable.engine.impl.bpmn.behavior that return VariableInstanceModifier and TypeMethodDescriptionMultiInstanceActivityBehavior.getLoopVariableInstance
(DelegateExecution execution, String variableName) -
Uses of VariableInstance in org.flowable.engine.impl.cmd
Methods in org.flowable.engine.impl.cmd that return VariableInstanceModifier and TypeMethodDescriptionGetExecutionVariableInstanceCmd.execute
(CommandContext commandContext) GetTaskVariableInstanceCmd.execute
(CommandContext commandContext) Methods in org.flowable.engine.impl.cmd that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionGetExecutionsVariablesCmd.execute
(CommandContext commandContext) GetExecutionVariableInstancesCmd.execute
(CommandContext commandContext) GetTasksLocalVariablesCmd.execute
(CommandContext commandContext) GetTaskVariableInstancesCmd.execute
(CommandContext commandContext) -
Uses of VariableInstance in org.flowable.engine.impl.delegate
Method parameters in org.flowable.engine.impl.delegate with type arguments of type VariableInstanceModifier and TypeMethodDescriptionJsonVariableAggregator.aggregateMultiVariables
(DelegateExecution execution, List<? extends VariableInstance> instances, VariableAggregatorContext context) -
Uses of VariableInstance in org.flowable.engine.impl.persistence.entity
Methods in org.flowable.engine.impl.persistence.entity with parameters of type VariableInstanceModifier and TypeMethodDescriptionprotected void
ExecutionEntityImpl.initializeVariableInstanceBackPointer
(VariableInstance variableInstance) -
Uses of VariableInstance in org.flowable.engine.impl.variable
Methods in org.flowable.engine.impl.variable that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionstatic Map<String,
List<VariableInstance>> BpmnAggregation.groupVariableInstancesByName
(List<? extends VariableInstance> instances) Method parameters in org.flowable.engine.impl.variable with type arguments of type VariableInstanceModifier and TypeMethodDescriptionstatic Map<String,
List<VariableInstance>> BpmnAggregation.groupVariableInstancesByName
(List<? extends VariableInstance> instances) static void
BpmnAggregation.sortVariablesByCounter
(List<VariableInstance> variableInstances, List<VariableInstance> counterVariableInstances) -
Uses of VariableInstance in org.flowable.rest.service.api
Methods in org.flowable.rest.service.api with parameters of type VariableInstanceModifier and TypeMethodDescriptionvoid
BpmnRestApiInterceptor.accessVariableInfoById
(VariableInstance variableInstance) RestResponseFactory.createVariableInstanceResponse
(VariableInstance variableInstance) RestResponseFactory.createVariableInstanceResponse
(VariableInstance variableInstance, RestUrlBuilder urlBuilder) Method parameters in org.flowable.rest.service.api with type arguments of type VariableInstanceModifier and TypeMethodDescriptionRestResponseFactory.createVariableInstanceResponseList
(List<VariableInstance> variableInstances) -
Uses of VariableInstance in org.flowable.task.service.impl.persistence.entity
Methods in org.flowable.task.service.impl.persistence.entity with parameters of type VariableInstanceModifier and TypeMethodDescriptionprotected void
TaskEntityImpl.initializeVariableInstanceBackPointer
(VariableInstance variableInstance) -
Uses of VariableInstance in org.flowable.variable.api.delegate
Methods in org.flowable.variable.api.delegate that return VariableInstanceModifier and TypeMethodDescriptionVariableScope.getVariableInstance
(String variableName) Similar toVariableScope.getVariable(String)
, but returns aVariableInstance
instance, which contains more information than just the value.VariableScope.getVariableInstance
(String variableName, boolean fetchAllVariables) Similar toVariableScope.getVariable(String, boolean)
, but returns an instance ofVariableInstance
, which has some additional information beyond the value.VariableScope.getVariableInstanceLocal
(String variableName) Similar toVariableScope.getVariableLocal(String)
, but returns an instance ofVariableInstance
, which has some additional information beyond the value.VariableScope.getVariableInstanceLocal
(String variableName, boolean fetchAllVariables) Similar toVariableScope.getVariableLocal(String, boolean)
, but returns an instance ofVariableInstance
, which has some additional information beyond the value.Methods in org.flowable.variable.api.delegate that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionVariableScope.getVariableInstances()
Returns all variables, as instances of theVariableInstance
interface, which gives more information than only the value (type, execution id, etc.)VariableScope.getVariableInstances
(Collection<String> variableNames) Similar toVariableScope.getVariableInstances()
, but limited to only the variables with the provided names.VariableScope.getVariableInstances
(Collection<String> variableNames, boolean fetchAllVariables) Similar toVariableScope.getVariables(Collection, boolean)
but returns the variables as instances of theVariableInstance
interface, which gives more information than only the value (type, execution id, etc.)VariableScope.getVariableInstancesLocal()
Returns the variables local to this scope as instances of theVariableInstance
interface, which provided additional information about the variable.VariableScope.getVariableInstancesLocal
(Collection<String> variableNames) Similar toVariableScope.getVariableInstances(Collection)
, but only for variables local to this scope.VariableScope.getVariableInstancesLocal
(Collection<String> variableNames, boolean fetchAllVariables) Similar toVariableScope.getVariableInstances(Collection, boolean)
, but only for variables local to this scope. -
Uses of VariableInstance in org.flowable.variable.service.event.impl
Methods in org.flowable.variable.service.event.impl with parameters of type VariableInstanceModifier and TypeMethodDescriptionstatic FlowableVariableEvent
FlowableVariableEventBuilder.createVariableEvent
(FlowableEngineEventType type, VariableInstance variableInstance, Object variableValue, VariableType variableType) -
Uses of VariableInstance in org.flowable.variable.service.impl
Methods in org.flowable.variable.service.impl that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionNativeVariableInstanceQueryImpl.executeList
(CommandContext commandContext, Map<String, Object> parameterMap) VariableInstanceQueryImpl.executeList
(CommandContext commandContext) Methods in org.flowable.variable.service.impl with parameters of type VariableInstanceModifier and TypeMethodDescriptionvoid
DefaultVariableInstanceValueModifier.setVariableValue
(VariableInstance variableInstance, Object value, String tenantId) void
VariableInstanceValueModifier.setVariableValue
(VariableInstance variableInstance, Object value, String tenantId) Sets the value of a new persistent or transient variable instance.void
DefaultVariableInstanceValueModifier.updateVariableValue
(VariableInstance variableInstance, Object value, String tenantId) void
VariableInstanceValueModifier.updateVariableValue
(VariableInstance variableInstance, Object value, String tenantId) Updates the value of a variable instance. -
Uses of VariableInstance in org.flowable.variable.service.impl.el
Methods in org.flowable.variable.service.impl.el that return VariableInstanceModifier and TypeMethodDescriptionNoExecutionVariableScope.getVariableInstance
(String variableName) NoExecutionVariableScope.getVariableInstance
(String variableName, boolean fetchAllVariables) NoExecutionVariableScope.getVariableInstanceLocal
(String variableName) NoExecutionVariableScope.getVariableInstanceLocal
(String variableName, boolean fetchAllVariables) Methods in org.flowable.variable.service.impl.el that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionNoExecutionVariableScope.getVariableInstances()
NoExecutionVariableScope.getVariableInstances
(Collection<String> variableNames) NoExecutionVariableScope.getVariableInstances
(Collection<String> variableNames, boolean fetchAllVariables) NoExecutionVariableScope.getVariableInstancesLocal()
NoExecutionVariableScope.getVariableInstancesLocal
(Collection<String> variableNames) NoExecutionVariableScope.getVariableInstancesLocal
(Collection<String> variableNames, boolean fetchAllVariables) -
Uses of VariableInstance in org.flowable.variable.service.impl.persistence.entity
Subinterfaces of VariableInstance in org.flowable.variable.service.impl.persistence.entityClasses in org.flowable.variable.service.impl.persistence.entity that implement VariableInstanceModifier and TypeClassDescriptionclass
A dummy implementation ofVariableInstance
, used for storing transient variables on aVariableScope
, as theVariableScope
works with instances ofVariableInstance
and not with raw key/values.class
Fields in org.flowable.variable.service.impl.persistence.entity with type parameters of type VariableInstanceModifier and TypeFieldDescriptionprotected Map<String,
VariableInstance> VariableScopeImpl.transientVariables
Methods in org.flowable.variable.service.impl.persistence.entity that return VariableInstanceModifier and TypeMethodDescriptionVariableScopeImpl.getVariableInstance
(String variableName) VariableScopeImpl.getVariableInstance
(String variableName, boolean fetchAllVariables) VariableScopeImpl.getVariableInstanceLocal
(String variableName) VariableScopeImpl.getVariableInstanceLocal
(String variableName, boolean fetchAllVariables) Methods in org.flowable.variable.service.impl.persistence.entity that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionprotected Map<String,
VariableInstance> VariableScopeImpl.collectVariableInstances
(HashMap<String, VariableInstance> variables) VariableInstanceEntityManager.findVariableInstancesByNativeQuery
(Map<String, Object> parameterMap) VariableInstanceEntityManagerImpl.findVariableInstancesByNativeQuery
(Map<String, Object> parameterMap) VariableInstanceEntityManager.findVariableInstancesByQueryCriteria
(VariableInstanceQueryImpl variableInstanceQuery) VariableInstanceEntityManagerImpl.findVariableInstancesByQueryCriteria
(VariableInstanceQueryImpl variableInstanceQuery) VariableScopeImpl.getVariableInstances()
VariableScopeImpl.getVariableInstances
(Collection<String> variableNames) VariableScopeImpl.getVariableInstances
(Collection<String> variableNames, boolean fetchAllVariables) VariableScopeImpl.getVariableInstancesLocal()
VariableScopeImpl.getVariableInstancesLocal
(Collection<String> variableNames) VariableScopeImpl.getVariableInstancesLocal
(Collection<String> variableNames, boolean fetchAllVariables) Methods in org.flowable.variable.service.impl.persistence.entity with parameters of type VariableInstanceModifier and TypeMethodDescriptionprotected abstract void
VariableScopeImpl.initializeVariableInstanceBackPointer
(VariableInstance variableInstance) Method parameters in org.flowable.variable.service.impl.persistence.entity with type arguments of type VariableInstanceModifier and TypeMethodDescriptionprotected Map<String,
VariableInstance> VariableScopeImpl.collectVariableInstances
(HashMap<String, VariableInstance> variables) -
Uses of VariableInstance in org.flowable.variable.service.impl.persistence.entity.data
Methods in org.flowable.variable.service.impl.persistence.entity.data that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionVariableInstanceDataManager.findVariableInstancesByNativeQuery
(Map<String, Object> parameterMap) VariableInstanceDataManager.findVariableInstancesByQueryCriteria
(VariableInstanceQueryImpl variableInstanceQuery) -
Uses of VariableInstance in org.flowable.variable.service.impl.persistence.entity.data.impl
Methods in org.flowable.variable.service.impl.persistence.entity.data.impl that return types with arguments of type VariableInstanceModifier and TypeMethodDescriptionMybatisVariableInstanceDataManager.findVariableInstancesByNativeQuery
(Map<String, Object> parameterMap) MybatisVariableInstanceDataManager.findVariableInstancesByQueryCriteria
(VariableInstanceQueryImpl variableInstanceQuery)