Class HistoricVariableInstanceQueryImpl

java.lang.Object

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

org.flowable.common.engine.impl.query.AbstractQuery<HistoricVariableInstanceQuery, HistoricVariableInstance>

org.flowable.variable.service.impl.HistoricVariableInstanceQueryImpl

All Implemented Interfaces:

Serializable, Query<HistoricVariableInstanceQuery, HistoricVariableInstance>, Command<Object>, HistoricVariableInstanceQuery

public class HistoricVariableInstanceQueryImpl
extends AbstractQuery<HistoricVariableInstanceQuery, HistoricVariableInstance>
implements HistoricVariableInstanceQuery

Author:

Joram Barrez, Tijs Rademakers

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ListQueryParameterObject

ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType

Nested classes/interfaces inherited from interface 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 Collection<String>	processInstanceIds
protected QueryVariableValue	queryVariableValue
protected String	scopeId
protected Collection<String>	scopeIds
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 AbstractQuery

commandContext, commandExecutor

Fields inherited from class ListQueryParameterObject

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
HistoricVariableInstanceQuery	activityInstanceId(String activityInstanceId)
protected void	ensureVariablesInitialized()
HistoricVariableInstanceQuery	excludeLocalVariables()	Only select historic process variables which were not set local.
HistoricVariableInstanceQuery	excludeTaskVariables()	Only select historic process variables which were not set task-local.
HistoricVariableInstanceQuery	excludeVariableInitialization()	Don't initialize variable values.
long	executeCount(CommandContext commandContext)
List<HistoricVariableInstance>	executeList(CommandContext commandContext)	Executes the actual query to retrieve the list of results.
HistoricVariableInstanceQueryImpl	executionId(String executionId)	Only select historic process variables with the given id.
HistoricVariableInstanceQueryImpl	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()
Collection<String>	getProcessInstanceIds()
QueryVariableValue	getQueryVariableValue()
List<List<String>>	getSafeProcessInstanceIds()
List<List<String>>	getSafeScopeIds()
List<List<String>>	getSafeTaskIds()
String	getScopeId()
Collection<String>	getScopeIds()
String	getScopeType()
String	getSubScopeId()
String	getTaskId()
Set<String>	getTaskIds()
String	getVariableName()
String	getVariableNameLike()
HistoricVariableInstanceQuery	id(String id)	Only select a historic variable with the given id.
boolean	isExcludeLocalVariables()
boolean	isExcludeTaskRelated()
boolean	isExcludeVariableInitialization()
HistoricVariableInstanceQuery	orderByProcessInstanceId()
HistoricVariableInstanceQuery	orderByVariableName()
HistoricVariableInstanceQueryImpl	processInstanceId(String processInstanceId)	Only select historic process variables with the given process instance.
HistoricVariableInstanceQuery	processInstanceIds(Collection<String> processInstanceIds)	Only select historic process variables with the given process instances.
HistoricVariableInstanceQuery	scopeId(String scopeId)	Only select historic variables with the given scope id.
HistoricVariableInstanceQuery	scopeIds(Collection<String> scopeIds)	Only select historic variables with the given scope ids.
HistoricVariableInstanceQuery	scopeType(String scopeType)	Only select historic variables with the give scope type.
HistoricVariableInstanceQuery	subScopeId(String subScopeId)	Only select historic variables with the given sub scope id.
HistoricVariableInstanceQuery	taskId(String taskId)	Only select historic process variables with the given task.
HistoricVariableInstanceQueryImpl	taskIds(Set<String> taskIds)	Only select historic process variables whose id is in the given set of ids.
HistoricVariableInstanceQuery	variableName(String variableName)	Only select historic process variables with the given variable name.
HistoricVariableInstanceQuery	variableNameLike(String variableNameLike)	Only select historic process variables where the given variable name is like.
HistoricVariableInstanceQuery	variableValueEquals(String variableName, Object variableValue)	only select historic process variables with the given name and value
HistoricVariableInstanceQuery	variableValueLike(String variableName, String variableValue)	only select historic process variables like the given name and value
HistoricVariableInstanceQuery	variableValueLikeIgnoreCase(String variableName, String variableValue)	only select historic process variables like the given name and value (case insensitive)
HistoricVariableInstanceQuery	variableValueNotEquals(String variableName, Object variableValue)	only select historic process variables that don't have the given name and value

Methods inherited from class AbstractQuery

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

Methods inherited from class ListQueryParameterObject

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

Methods inherited from class Object

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

Methods inherited from interface 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

processInstanceIds

protected Collection<String> processInstanceIds

activityInstanceId

protected String activityInstanceId

variableName

protected String variableName

variableNameLike

protected String variableNameLike

excludeTaskRelated

protected boolean excludeTaskRelated

excludeVariableInitialization

protected boolean excludeVariableInitialization

scopeId

protected String scopeId

scopeIds

protected Collection<String> scopeIds

subScopeId

protected String subScopeId

scopeType

protected String scopeType

queryVariableValue

protected QueryVariableValue queryVariableValue

excludeLocalVariables

protected boolean excludeLocalVariables

Constructor Details

HistoricVariableInstanceQueryImpl

public HistoricVariableInstanceQueryImpl()

HistoricVariableInstanceQueryImpl

public HistoricVariableInstanceQueryImpl(CommandContext commandContext,
 VariableServiceConfiguration variableServiceConfiguration)

HistoricVariableInstanceQueryImpl

public HistoricVariableInstanceQueryImpl(CommandExecutor commandExecutor,
 VariableServiceConfiguration variableServiceConfiguration)

Method Details

id

public HistoricVariableInstanceQuery id(String id)

Description copied from interface: HistoricVariableInstanceQuery

Only select a historic variable with the given id.

Specified by:

id in interface HistoricVariableInstanceQuery

processInstanceId

public HistoricVariableInstanceQueryImpl processInstanceId(String processInstanceId)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic process variables with the given process instance.

Specified by:

processInstanceId in interface HistoricVariableInstanceQuery

processInstanceIds

public HistoricVariableInstanceQuery processInstanceIds(Collection<String> processInstanceIds)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic process variables with the given process instances.

Specified by:

processInstanceIds in interface HistoricVariableInstanceQuery

executionId

public HistoricVariableInstanceQueryImpl executionId(String executionId)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic process variables with the given id.

Specified by:

executionId in interface HistoricVariableInstanceQuery

executionIds

public HistoricVariableInstanceQueryImpl executionIds(Set<String> executionIds)

Description copied from interface: HistoricVariableInstanceQuery

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

Specified by:

executionIds in interface HistoricVariableInstanceQuery

activityInstanceId

public HistoricVariableInstanceQuery activityInstanceId(String activityInstanceId)

taskId

public HistoricVariableInstanceQuery taskId(String taskId)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic process variables with the given task.

Specified by:

taskId in interface HistoricVariableInstanceQuery

taskIds

public HistoricVariableInstanceQueryImpl taskIds(Set<String> taskIds)

Description copied from interface: HistoricVariableInstanceQuery

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

Specified by:

taskIds in interface HistoricVariableInstanceQuery

excludeTaskVariables

public HistoricVariableInstanceQuery excludeTaskVariables()

Description copied from interface: HistoricVariableInstanceQuery

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

Specified by:

excludeTaskVariables in interface HistoricVariableInstanceQuery

excludeVariableInitialization

public HistoricVariableInstanceQuery excludeVariableInitialization()

Description copied from interface: HistoricVariableInstanceQuery

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

Specified by:

excludeVariableInitialization in interface HistoricVariableInstanceQuery

variableName

public HistoricVariableInstanceQuery variableName(String variableName)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic process variables with the given variable name.

Specified by:

variableName in interface HistoricVariableInstanceQuery

variableValueEquals

public HistoricVariableInstanceQuery variableValueEquals(String variableName,
 Object variableValue)

Description copied from interface: HistoricVariableInstanceQuery

only select historic process variables with the given name and value

Specified by:

variableValueEquals in interface HistoricVariableInstanceQuery

variableValueNotEquals

public HistoricVariableInstanceQuery variableValueNotEquals(String variableName,
 Object variableValue)

Description copied from interface: HistoricVariableInstanceQuery

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

Specified by:

variableValueNotEquals in interface HistoricVariableInstanceQuery

variableValueLike

public HistoricVariableInstanceQuery variableValueLike(String variableName,
 String variableValue)

Description copied from interface: HistoricVariableInstanceQuery

only select historic process variables like the given name and value

Specified by:

variableValueLike in interface HistoricVariableInstanceQuery

variableValueLikeIgnoreCase

public HistoricVariableInstanceQuery variableValueLikeIgnoreCase(String variableName,
 String variableValue)

Description copied from interface: HistoricVariableInstanceQuery

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

Specified by:

variableValueLikeIgnoreCase in interface HistoricVariableInstanceQuery

variableNameLike

public HistoricVariableInstanceQuery variableNameLike(String variableNameLike)

Description copied from interface: HistoricVariableInstanceQuery

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

Specified by:

variableNameLike in interface HistoricVariableInstanceQuery

scopeId

public HistoricVariableInstanceQuery scopeId(String scopeId)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic variables with the given scope id.

Specified by:

scopeId in interface HistoricVariableInstanceQuery

scopeIds

public HistoricVariableInstanceQuery scopeIds(Collection<String> scopeIds)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic variables with the given scope ids.

Specified by:

scopeIds in interface HistoricVariableInstanceQuery

subScopeId

public HistoricVariableInstanceQuery subScopeId(String subScopeId)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic variables with the given sub scope id.

Specified by:

subScopeId in interface HistoricVariableInstanceQuery

scopeType

public HistoricVariableInstanceQuery scopeType(String scopeType)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic variables with the give scope type.

Specified by:

scopeType in interface HistoricVariableInstanceQuery

excludeLocalVariables

public HistoricVariableInstanceQuery excludeLocalVariables()

Description copied from interface: HistoricVariableInstanceQuery

Only select historic process variables which were not set local.

Specified by:

excludeLocalVariables in interface HistoricVariableInstanceQuery

ensureVariablesInitialized

protected void ensureVariablesInitialized()

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<HistoricVariableInstanceQuery, HistoricVariableInstance>

executeList

public List<HistoricVariableInstance> executeList(CommandContext commandContext)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<HistoricVariableInstanceQuery, HistoricVariableInstance>

orderByProcessInstanceId

public HistoricVariableInstanceQuery orderByProcessInstanceId()

Specified by:

orderByProcessInstanceId in interface HistoricVariableInstanceQuery

orderByVariableName

public HistoricVariableInstanceQuery orderByVariableName()

Specified by:

orderByVariableName in interface HistoricVariableInstanceQuery

getProcessInstanceId

public String getProcessInstanceId()

getProcessInstanceIds

public Collection<String> getProcessInstanceIds()

getSafeProcessInstanceIds

public List<List<String>> getSafeProcessInstanceIds()

getTaskId

public String getTaskId()

getActivityInstanceId

public String getActivityInstanceId()

getExcludeTaskRelated

public boolean getExcludeTaskRelated()

getVariableName

public String getVariableName()

getVariableNameLike

public String getVariableNameLike()

getScopeId

public String getScopeId()

getScopeIds

public Collection<String> getScopeIds()

getSafeScopeIds

public List<List<String>> getSafeScopeIds()

getSubScopeId

public String getSubScopeId()

getScopeType

public String getScopeType()

getId

public String getId()

getTaskIds

public Set<String> getTaskIds()

getSafeTaskIds

public List<List<String>> getSafeTaskIds()

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()