Index
All Classes and Interfaces|All Packages
A
- addType(VariableType) - Method in interface org.flowable.variable.api.types.VariableTypes
- addType(VariableType, int) - Method in interface org.flowable.variable.api.types.VariableTypes
-
Add type at the given index.
- addTypeBefore(VariableType, String) - Method in interface org.flowable.variable.api.types.VariableTypes
-
Add the variable type before the type with the given name.
E
- empty() - Static method in interface org.flowable.variable.api.delegate.VariableScope
- excludeLocalVariables() - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic process variables which were not set local.
- excludeLocalVariables() - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic process variables which were not set local.
- excludeTaskVariables() - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic process variables which were not set task-local.
- excludeTaskVariables() - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic process variables which were not set task-local.
- excludeVariableInitialization() - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Don't initialize variable values.
- excludeVariableInitialization() - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Don't initialize variable values.
- executionId(String) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic process variables with the given id.
- executionId(String) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic process variables with the given id.
- executionIds(Set<String>) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic process variables whose id is in the given set of ids.
- executionIds(Set<String>) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic process variables whose id is in the given set of ids.
F
- findVariableType(Object) - Method in interface org.flowable.variable.api.types.VariableTypes
- FlowableVariableEvent - Interface in org.flowable.variable.api.event
-
An
FlowableEvent
related to a single variable.
G
- getBytes() - Method in interface org.flowable.variable.api.types.ValueFields
- getCachedValue() - Method in interface org.flowable.variable.api.types.ValueFields
- getCreateTime() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
-
Returns the time when the variable was created.
- getDoubleValue() - Method in interface org.flowable.variable.api.types.ValueFields
- getExecutionId() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
-
The process instance reference.
- getExecutionId() - Method in interface org.flowable.variable.api.types.ValueFields
- getId() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
-
The unique DB id
- getId() - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- getLastUpdatedTime() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
-
Returns the time when the value of the variable was last updated.
- getLongValue() - Method in interface org.flowable.variable.api.types.ValueFields
- getMetaInfo() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
- getMetaInfo() - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- getName() - Method in interface org.flowable.variable.api.types.ValueFields
- getProcessDefinitionId() - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- getProcessInstanceId() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
-
The process instance reference.
- getProcessInstanceId() - Method in interface org.flowable.variable.api.types.ValueFields
- getScopeDefinitionId() - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- getScopeId() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
- getScopeId() - Method in interface org.flowable.variable.api.types.ValueFields
- getScopeType() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
- getScopeType() - Method in interface org.flowable.variable.api.types.ValueFields
- getSubScopeId() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
- getSubScopeId() - Method in interface org.flowable.variable.api.types.ValueFields
- getTaskId() - Method in interface org.flowable.variable.api.event.FlowableVariableEvent
- getTaskId() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
- getTaskId() - Method in interface org.flowable.variable.api.types.ValueFields
- getTextValue() - Method in interface org.flowable.variable.api.types.ValueFields
- getTextValue2() - Method in interface org.flowable.variable.api.types.ValueFields
- getTransientVariable(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariable(String)
, including the searching via the parent scopes, but for transient variables only. - getTransientVariableLocal(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariableLocal(String)
, but for a transient variable. - getTransientVariables() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariables()
, but for transient variables only. - getTransientVariablesLocal() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariableLocal(String)
, but for transient variables only. - getTypeIndex(String) - Method in interface org.flowable.variable.api.types.VariableTypes
- getTypeIndex(VariableType) - Method in interface org.flowable.variable.api.types.VariableTypes
- getTypeName() - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- getTypeName() - Method in interface org.flowable.variable.api.types.VariableType
-
name of variable type (limited to 100 characters length)
- getValue() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
- getValue() - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- getValue(ValueFields) - Method in interface org.flowable.variable.api.types.VariableType
- getVariable(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns the variable value for one specific variable.
- getVariable(String, boolean) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariable(String)
, but has an extra flag that indicates whether or not all variables need to be fetched when getting one variable. - getVariable(String, Class<T>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Typed version of the
VariableScope.getVariable(String)
method. - getVariableInstance(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariable(String)
, but returns aVariableInstance
instance, which contains more information than just the value. - getVariableInstance(String, boolean) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariable(String, boolean)
, but returns an instance ofVariableInstance
, which has some additional information beyond the value. - getVariableInstanceId() - Method in interface org.flowable.variable.api.event.FlowableVariableEvent
- getVariableInstanceLocal(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariableLocal(String)
, but returns an instance ofVariableInstance
, which has some additional information beyond the value. - getVariableInstanceLocal(String, boolean) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariableLocal(String, boolean)
, but returns an instance ofVariableInstance
, which has some additional information beyond the value. - getVariableInstances() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns all variables, as instances of the
VariableInstance
interface, which gives more information than only the value (type, execution id, etc.) - getVariableInstances(Collection<String>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariableInstances()
, but limited to only the variables with the provided names. - getVariableInstances(Collection<String>, boolean) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariables(Collection, boolean)
but returns the variables as instances of theVariableInstance
interface, which gives more information than only the value (type, execution id, etc.) - getVariableInstancesLocal() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns the variables local to this scope as instances of the
VariableInstance
interface, which provided additional information about the variable. - getVariableInstancesLocal(Collection<String>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariableInstances(Collection)
, but only for variables local to this scope. - getVariableInstancesLocal(Collection<String>, boolean) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariableInstances(Collection, boolean)
, but only for variables local to this scope. - getVariableLocal(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns the value for the specific variable and only checks this scope and not any parent scope.
- getVariableLocal(String, boolean) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariableLocal(String)
, but has an extra flag that indicates whether or not all variables need to be fetched when getting one variable. - getVariableLocal(String, Class<T>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Typed version of the
VariableScope.getVariableLocal(String)
method. - getVariableName() - Method in interface org.flowable.variable.api.event.FlowableVariableEvent
- getVariableName() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
- getVariableNames() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns all the names of the variables for this scope and all parent scopes.
- getVariableNamesLocal() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns all the names of the variables for this scope (no parent scopes).
- getVariables() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns all variables.
- getVariables(Collection<String>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariables()
, but limited to only the variables with the provided names. - getVariables(Collection<String>, boolean) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariables(Collection)
, but with a flag that indicates that all variables should be fetched when fetching the specific variables. - getVariablesLocal() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns the variable local to this scope only.
- getVariablesLocal(Collection<String>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariables(Collection)
, but only for variables local to this scope. - getVariablesLocal(Collection<String>, boolean) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.getVariables(Collection, boolean)
, but only for variables local to this scope. - getVariableType() - Method in interface org.flowable.variable.api.event.FlowableVariableEvent
- getVariableType(String) - Method in interface org.flowable.variable.api.types.VariableTypes
- getVariableTypeName() - Method in interface org.flowable.variable.api.history.HistoricVariableInstance
- getVariableValue() - Method in interface org.flowable.variable.api.event.FlowableVariableEvent
H
- hasVariable(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns whether this scope or any parent scope has a specific variable.
- hasVariableLocal(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns whether this scope has a specific variable.
- hasVariables() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns whether this scope or any parent scope has variables.
- hasVariablesLocal() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Returns whether this scope has variables.
- HistoricVariableInstance - Interface in org.flowable.variable.api.history
-
A single process variable containing the last value when its process instance has finished.
- HistoricVariableInstanceQuery - Interface in org.flowable.variable.api.history
-
Programmatic querying for
HistoricVariableInstance
s.
I
- id(String) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select a historic variable with the given id.
- id(String) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select a historic variable with the given id.
- isAbleToStore(Object) - Method in interface org.flowable.variable.api.types.VariableType
- isCachable() - Method in interface org.flowable.variable.api.types.VariableType
-
Indicates if this variable type supports caching.
- isReadOnly() - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- isReadOnly() - Method in interface org.flowable.variable.api.types.VariableType
N
- NativeHistoricVariableInstanceQuery - Interface in org.flowable.variable.api.history
-
Allows querying of
HistoricVariableInstance
s via native (SQL) queries - NativeVariableInstanceQuery - Interface in org.flowable.variable.api.runtime
-
Allows querying of
VariableInstance
s via native (SQL) queries
O
- orderByProcessInstanceId() - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
- orderByProcessInstanceId() - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
- orderByVariableName() - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
- orderByVariableName() - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
- org.flowable.variable.api.delegate - package org.flowable.variable.api.delegate
- org.flowable.variable.api.event - package org.flowable.variable.api.event
- org.flowable.variable.api.history - package org.flowable.variable.api.history
- org.flowable.variable.api.persistence.entity - package org.flowable.variable.api.persistence.entity
- org.flowable.variable.api.runtime - package org.flowable.variable.api.runtime
- org.flowable.variable.api.types - package org.flowable.variable.api.types
P
- processInstanceId(String) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic process variables with the given process instance.
- processInstanceId(String) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic process variables with the given process instance.
R
- removeTransientVariable(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Removes a specific transient variable.
- removeTransientVariableLocal(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Removes a specific transient variable (also searching parent scopes).
- removeTransientVariables() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Remove all transient variable of this scope and its parent scopes.
- removeTransientVariablesLocal() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Removes all local transient variables.
- removeType(VariableType) - Method in interface org.flowable.variable.api.types.VariableTypes
- removeVariable(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Removes the variable and creates a new HistoricVariableUpdate.
- removeVariableLocal(String) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Removes the local variable and creates a new HistoricVariableUpdate.
- removeVariables() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Removes the (local) variables and creates a new HistoricVariableUpdate for each of them.
- removeVariables(Collection<String>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Removes the variables and creates a new HistoricVariableUpdate for each of them.
- removeVariablesLocal() - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Removes the (local) variables and creates a new HistoricVariableUpdate for each of them.
- removeVariablesLocal(Collection<String>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Removes the local variables and creates a new HistoricVariableUpdate for each of them.
S
- scopeId(String) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic variables with the given scope id.
- scopeId(String) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic variables with the given scope id.
- scopeType(String) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic variables with the give scope type.
- scopeType(String) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic variables with the give scope type.
- setBytes(byte[]) - Method in interface org.flowable.variable.api.types.ValueFields
-
Sets the byte array value.
- setCachedValue(Object) - Method in interface org.flowable.variable.api.types.ValueFields
- setDoubleValue(Double) - Method in interface org.flowable.variable.api.types.ValueFields
-
Sets the double value.
- setExecutionId(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setId(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setLongValue(Long) - Method in interface org.flowable.variable.api.types.ValueFields
-
Sets the long value.
- setMetaInfo(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setName(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setProcessDefinitionId(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setProcessInstanceId(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setScopeDefinitionId(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setScopeId(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setScopeType(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setSubScopeId(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setTaskId(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setTextValue(String) - Method in interface org.flowable.variable.api.types.ValueFields
-
Sets the first text value.
- setTextValue2(String) - Method in interface org.flowable.variable.api.types.ValueFields
-
Sets second text value.
- setTransientVariable(String, Object) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.setVariable(String, Object)
, but the variable is transient: - no history is kept for the variable - the variable is only available until a waitstate is reached in the process - transient variables 'shadow' persistent variable (when getVariable('abc') where 'abc' is both persistent and transient, the transient value is returned. - setTransientVariableLocal(String, Object) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.setVariableLocal(String, Object)
, but for a transient variable. - setTransientVariables(Map<String, Object>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.setVariables(Map)
, but for transient variables. - setTransientVariablesLocal(Map<String, Object>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.setVariablesLocal(Map)
, but for transient variables. - setTypeName(String) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setValue(Object) - Method in interface org.flowable.variable.api.persistence.entity.VariableInstance
- setValue(Object, ValueFields) - Method in interface org.flowable.variable.api.types.VariableType
-
Stores the specified value in the supplied
ValueFields
. - setVariable(String, Object) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Sets the variable with the provided name to the provided value.
- setVariable(String, Object, boolean) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.setVariable(String, Object)
, but with an extra flag to indicate whether all variables should be fetched while doing this or not. - setVariableLocal(String, Object) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.setVariable(String, Object)
, but the variable is set to this scope specifically. - setVariableLocal(String, Object, boolean) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.setVariableLocal(String, Object)
, but with an extra flag to indicate whether all variables should be fetched while doing this or not. - setVariables(Map<String, ? extends Object>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Sets the provided variables to the variable scope.
- setVariablesLocal(Map<String, ? extends Object>) - Method in interface org.flowable.variable.api.delegate.VariableScope
-
Similar to
VariableScope.setVariables(Map)
, but the variable are set on this scope specifically. - subScopeId(String) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic variables with the given sub scope id.
- subScopeId(String) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic variables with the given sub scope id.
T
- taskId(String) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic process variables with the given task.
- taskId(String) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic process variables with the given task.
- taskIds(Set<String>) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic process variables whose id is in the given set of ids.
- taskIds(Set<String>) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic process variables whose id is in the given set of ids.
V
- ValueFields - Interface in org.flowable.variable.api.types
-
Common interface for regular and historic variable entities.
- VariableInstance - Interface in org.flowable.variable.api.persistence.entity
-
Generic variable class that can be reused for V6 and V5 engine.
- VariableInstanceQuery - Interface in org.flowable.variable.api.runtime
-
Programmatic querying for
VariableInstance
s. - variableName(String) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic process variables with the given variable name.
- variableName(String) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic process variables with the given variable name.
- variableNameLike(String) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
Only select historic process variables where the given variable name is like.
- variableNameLike(String) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
Only select historic process variables where the given variable name is like.
- VariableScope - Interface in org.flowable.variable.api.delegate
-
Interface for class that acts as a scope for variables: i.e. the implementation can be used to set and get variables.
- VariableType - Interface in org.flowable.variable.api.types
- VariableTypes - Interface in org.flowable.variable.api.types
-
Interface describing a container for all available
VariableType
s of variables. - variableValueEquals(String, Object) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
only select historic process variables with the given name and value
- variableValueEquals(String, Object) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
only select historic process variables with the given name and value
- variableValueLike(String, String) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
only select historic process variables like the given name and value
- variableValueLike(String, String) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
only select historic process variables like the given name and value
- variableValueLikeIgnoreCase(String, String) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
only select historic process variables like the given name and value (case insensitive)
- variableValueLikeIgnoreCase(String, String) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
only select historic process variables like the given name and value (case insensitive)
- variableValueNotEquals(String, Object) - Method in interface org.flowable.variable.api.history.HistoricVariableInstanceQuery
-
only select historic process variables that don't have the given name and value
- variableValueNotEquals(String, Object) - Method in interface org.flowable.variable.api.runtime.VariableInstanceQuery
-
only select historic process variables that don't have the given name and value
All Classes and Interfaces|All Packages