Package org.flowable.variable.service.impl

Class VariableInstanceQueryImpl

java.lang.Object

org.flowable.common.engine.impl.db.ListQueryParameterObject

org.flowable.common.engine.impl.query.AbstractQuery<VariableInstanceQuery,VariableInstance>

org.flowable.variable.service.impl.VariableInstanceQueryImpl

All Implemented Interfaces:

Serializable, Query<VariableInstanceQuery,VariableInstance>, Command<Object>, VariableInstanceQuery

public class VariableInstanceQueryImpl
extends AbstractQuery<VariableInstanceQuery,VariableInstance>
implements VariableInstanceQuery

Author:

Joram Barrez, Tijs Rademakers

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType

Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query

Query.NullHandlingOnOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	activityInstanceId
protected boolean	excludeLocalVariables
protected boolean	excludeTaskRelated
protected boolean	excludeVariableInitialization
protected String	executionId
protected Set<String>	executionIds
protected String	id
protected String	processInstanceId
protected QueryVariableValue	queryVariableValue
protected String	scopeId
protected String	scopeType
protected String	subScopeId
protected String	taskId
protected Set<String>	taskIds
protected String	variableName
protected String	variableNameLike
protected VariableServiceConfiguration	variableServiceConfiguration

Fields inherited from class org.flowable.common.engine.impl.query.AbstractQuery

commandContext, commandExecutor

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

databaseType, DEFAULT_ORDER_BY, defaultOrderBy, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors

Constructor	Description
VariableInstanceQueryImpl()
VariableInstanceQueryImpl(CommandContext commandContext, VariableServiceConfiguration variableServiceConfiguration)
VariableInstanceQueryImpl(CommandExecutor commandExecutor, VariableServiceConfiguration variableServiceConfiguration)

Method Summary

Modifier and Type	Method	Description
VariableInstanceQuery	activityInstanceId(String activityInstanceId)
protected void	ensureVariablesInitialized()
VariableInstanceQuery	excludeLocalVariables()	Only select historic process variables which were not set local.
VariableInstanceQuery	excludeTaskVariables()	Only select historic process variables which were not set task-local.
VariableInstanceQuery	excludeVariableInitialization()	Don't initialize variable values.
long	executeCount(CommandContext commandContext)
List<VariableInstance>	executeList(CommandContext commandContext)	Executes the actual query to retrieve the list of results.
VariableInstanceQueryImpl	executionId(String executionId)	Only select historic process variables with the given id.
VariableInstanceQueryImpl	executionIds(Set<String> executionIds)	Only select historic process variables whose id is in the given set of ids.
String	getActivityInstanceId()
boolean	getExcludeTaskRelated()
String	getExecutionId()
Set<String>	getExecutionIds()
String	getId()
String	getProcessInstanceId()
QueryVariableValue	getQueryVariableValue()
String	getScopeId()
String	getScopeType()
String	getSubScopeId()
String	getTaskId()
Set<String>	getTaskIds()
String	getVariableName()
String	getVariableNameLike()
VariableInstanceQuery	id(String id)	Only select a historic variable with the given id.
boolean	isExcludeLocalVariables()
boolean	isExcludeTaskRelated()
boolean	isExcludeVariableInitialization()
VariableInstanceQuery	orderByProcessInstanceId()
VariableInstanceQuery	orderByVariableName()
VariableInstanceQueryImpl	processInstanceId(String processInstanceId)	Only select historic process variables with the given process instance.
VariableInstanceQuery	scopeId(String scopeId)	Only select historic variables with the given scope id.
VariableInstanceQuery	scopeType(String scopeType)	Only select historic variables with the give scope type.
VariableInstanceQuery	subScopeId(String subScopeId)	Only select historic variables with the given sub scope id.
VariableInstanceQuery	taskId(String taskId)	Only select historic process variables with the given task.
VariableInstanceQueryImpl	taskIds(Set<String> taskIds)	Only select historic process variables whose id is in the given set of ids.
VariableInstanceQuery	variableName(String variableName)	Only select historic process variables with the given variable name.
VariableInstanceQuery	variableNameLike(String variableNameLike)	Only select historic process variables where the given variable name is like.
VariableInstanceQuery	variableValueEquals(String variableName, Object variableValue)	only select historic process variables with the given name and value
VariableInstanceQuery	variableValueLike(String variableName, String variableValue)	only select historic process variables like the given name and value
VariableInstanceQuery	variableValueLikeIgnoreCase(String variableName, String variableValue)	only select historic process variables like the given name and value (case insensitive)
VariableInstanceQuery	variableValueNotEquals(String variableName, Object variableValue)	only select historic process variables that don't have the given name and value

Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery

asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, list, listPage, orderBy, orderBy, setCommandExecutor, singleResult

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

addOrder, buildOrderBy, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getNullHandlingColumn, getOrderBy, getOrderByCollectionSafe, getOrderByForWindow, getOuterJoinOrderBy, getParameter, hasOrderBy, hasOrderByForColumn, isNeedsPaging, mapOrderByToSql, setDatabaseType, setFirstResult, setMaxResults, setNullHandlingColumn, setParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.flowable.common.engine.api.query.Query

asc, count, desc, list, listPage, orderBy, orderBy, singleResult

Field Details

variableServiceConfiguration

protected VariableServiceConfiguration variableServiceConfiguration

id

protected String id

taskId

protected String taskId

taskIds

protected Set<String> taskIds

executionId

protected String executionId

executionIds

protected Set<String> executionIds

processInstanceId

protected String processInstanceId

activityInstanceId

protected String activityInstanceId

variableName

protected String variableName

variableNameLike

protected String variableNameLike

excludeTaskRelated

protected boolean excludeTaskRelated

excludeVariableInitialization

protected boolean excludeVariableInitialization

scopeId

protected String scopeId

subScopeId

protected String subScopeId

scopeType

protected String scopeType

queryVariableValue

protected QueryVariableValue queryVariableValue

excludeLocalVariables

protected boolean excludeLocalVariables

Constructor Details

VariableInstanceQueryImpl

public VariableInstanceQueryImpl()

VariableInstanceQueryImpl

public VariableInstanceQueryImpl(CommandContext commandContext,
 VariableServiceConfiguration variableServiceConfiguration)

VariableInstanceQueryImpl

public VariableInstanceQueryImpl(CommandExecutor commandExecutor,
 VariableServiceConfiguration variableServiceConfiguration)

Method Details

id

public VariableInstanceQuery id(String id)

Description copied from interface: VariableInstanceQuery

Only select a historic variable with the given id.

Specified by:

id in interface VariableInstanceQuery

processInstanceId

public VariableInstanceQueryImpl processInstanceId(String processInstanceId)

Description copied from interface: VariableInstanceQuery

Only select historic process variables with the given process instance.

Specified by:

processInstanceId in interface VariableInstanceQuery

executionId

public VariableInstanceQueryImpl executionId(String executionId)

Description copied from interface: VariableInstanceQuery

Only select historic process variables with the given id.

Specified by:

executionId in interface VariableInstanceQuery

executionIds

public VariableInstanceQueryImpl executionIds(Set<String> executionIds)

Description copied from interface: VariableInstanceQuery

Only select historic process variables whose id is in the given set of ids.

Specified by:

executionIds in interface VariableInstanceQuery

activityInstanceId

public VariableInstanceQuery activityInstanceId(String activityInstanceId)

taskId

public VariableInstanceQuery taskId(String taskId)

Description copied from interface: VariableInstanceQuery

Only select historic process variables with the given task.

Specified by:

taskId in interface VariableInstanceQuery

taskIds

public VariableInstanceQueryImpl taskIds(Set<String> taskIds)

Description copied from interface: VariableInstanceQuery

Only select historic process variables whose id is in the given set of ids.

Specified by:

taskIds in interface VariableInstanceQuery

excludeTaskVariables

public VariableInstanceQuery excludeTaskVariables()

Description copied from interface: VariableInstanceQuery

Only select historic process variables which were not set task-local.

Specified by:

excludeTaskVariables in interface VariableInstanceQuery

excludeVariableInitialization

public VariableInstanceQuery excludeVariableInitialization()

Description copied from interface: VariableInstanceQuery

Don't initialize variable values. This is foremost a way to deal with variable delete queries

Specified by:

excludeVariableInitialization in interface VariableInstanceQuery

variableName

public VariableInstanceQuery variableName(String variableName)

Description copied from interface: VariableInstanceQuery

Only select historic process variables with the given variable name.

Specified by:

variableName in interface VariableInstanceQuery

variableValueEquals

public VariableInstanceQuery variableValueEquals(String variableName,
 Object variableValue)

Description copied from interface: VariableInstanceQuery

only select historic process variables with the given name and value

Specified by:

variableValueEquals in interface VariableInstanceQuery

variableValueNotEquals

public VariableInstanceQuery variableValueNotEquals(String variableName,
 Object variableValue)

Description copied from interface: VariableInstanceQuery

only select historic process variables that don't have the given name and value

Specified by:

variableValueNotEquals in interface VariableInstanceQuery

variableValueLike

public VariableInstanceQuery variableValueLike(String variableName,
 String variableValue)

Description copied from interface: VariableInstanceQuery

only select historic process variables like the given name and value

Specified by:

variableValueLike in interface VariableInstanceQuery

variableValueLikeIgnoreCase

public VariableInstanceQuery variableValueLikeIgnoreCase(String variableName,
 String variableValue)

Description copied from interface: VariableInstanceQuery

only select historic process variables like the given name and value (case insensitive)

Specified by:

variableValueLikeIgnoreCase in interface VariableInstanceQuery

variableNameLike

public VariableInstanceQuery variableNameLike(String variableNameLike)

Description copied from interface: VariableInstanceQuery

Only select historic process variables where the given variable name is like.

Specified by:

variableNameLike in interface VariableInstanceQuery

scopeId

public VariableInstanceQuery scopeId(String scopeId)

Description copied from interface: VariableInstanceQuery

Only select historic variables with the given scope id.

Specified by:

scopeId in interface VariableInstanceQuery

subScopeId

public VariableInstanceQuery subScopeId(String subScopeId)

Description copied from interface: VariableInstanceQuery

Only select historic variables with the given sub scope id.

Specified by:

subScopeId in interface VariableInstanceQuery

scopeType

public VariableInstanceQuery scopeType(String scopeType)

Description copied from interface: VariableInstanceQuery

Only select historic variables with the give scope type.

Specified by:

scopeType in interface VariableInstanceQuery

excludeLocalVariables

public VariableInstanceQuery excludeLocalVariables()

Description copied from interface: VariableInstanceQuery

Only select historic process variables which were not set local.

Specified by:

excludeLocalVariables in interface VariableInstanceQuery

ensureVariablesInitialized

protected void ensureVariablesInitialized()

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<VariableInstanceQuery,VariableInstance>

executeList

public List<VariableInstance> executeList(CommandContext commandContext)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<VariableInstanceQuery,VariableInstance>

orderByProcessInstanceId

public VariableInstanceQuery orderByProcessInstanceId()

Specified by:

orderByProcessInstanceId in interface VariableInstanceQuery

orderByVariableName

public VariableInstanceQuery orderByVariableName()

Specified by:

orderByVariableName in interface VariableInstanceQuery

getProcessInstanceId

public String getProcessInstanceId()

getTaskId

public String getTaskId()

getActivityInstanceId

public String getActivityInstanceId()

getExcludeTaskRelated

public boolean getExcludeTaskRelated()

getVariableName

public String getVariableName()

getVariableNameLike

public String getVariableNameLike()

getScopeId

public String getScopeId()

getSubScopeId

public String getSubScopeId()

getScopeType

public String getScopeType()

getId

public String getId()

getTaskIds

public Set<String> getTaskIds()

getExecutionId

public String getExecutionId()

getExecutionIds

public Set<String> getExecutionIds()

isExcludeTaskRelated

public boolean isExcludeTaskRelated()

isExcludeVariableInitialization

public boolean isExcludeVariableInitialization()

getQueryVariableValue

public QueryVariableValue getQueryVariableValue()

isExcludeLocalVariables

public boolean isExcludeLocalVariables()