org.camunda.bpm.engine.impl

Class HistoricVariableInstanceQueryImpl

java.lang.Object

org.camunda.bpm.engine.impl.db.ListQueryParameterObject

org.camunda.bpm.engine.impl.AbstractQuery<HistoricVariableInstanceQuery,HistoricVariableInstance>

org.camunda.bpm.engine.impl.HistoricVariableInstanceQueryImpl

All Implemented Interfaces:

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

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

Author:

Christian Lipphardt (camunda)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery

AbstractQuery.ResultType

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	activityInstanceIds
protected String[]	caseActivityIds
protected String[]	caseExecutionIds
protected String	caseInstanceId
protected String[]	executionIds
protected boolean	includeDeleted
protected boolean	isByteArrayFetchingEnabled
protected boolean	isCustomObjectDeserializationEnabled
protected String	processDefinitionId
protected String	processDefinitionKey
protected String	processInstanceId
protected String[]	processInstanceIds
protected QueryVariableValue	queryVariableValue
protected String[]	taskIds
protected String[]	tenantIds
protected String	variableId
protected String	variableName
protected String	variableNameLike
protected String[]	variableTypes

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

commandExecutor, expressions, maxResultsLimitEnabled, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck

Constructor Summary

Constructors

Constructor and Description
HistoricVariableInstanceQueryImpl()
HistoricVariableInstanceQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method and Description
HistoricVariableInstanceQuery	activityInstanceIdIn(String... activityInstanceIds) Only select historic variable instances which have one of the activity instance ids.
HistoricVariableInstanceQuery	caseActivityIdIn(String... caseActivityIds) Only select historic variable instances with one of the given case activity ids.
HistoricVariableInstanceQuery	caseExecutionIdIn(String... caseExecutionIds) Only select historic variable instances which have one of the case executions ids.
HistoricVariableInstanceQuery	caseInstanceId(String caseInstanceId) Only select historic case variables with the given case instance.
HistoricVariableInstanceQuery	disableBinaryFetching() Disable fetching of byte array and file values.
HistoricVariableInstanceQuery	disableCustomObjectDeserialization() Disable deserialization of variable values that are custom objects.
protected void	ensureVariablesInitialized()
long	executeCount(CommandContext commandContext)
List<HistoricVariableInstance>	executeList(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.
HistoricVariableInstanceQuery	executionIdIn(String... executionIds) Only select historic variable instances which have one of the executions ids.
String[]	getActivityInstanceIds()
String[]	getCaseActivityIds()
String[]	getCaseExecutionIds()
String	getCaseInstanceId()
String[]	getExecutionIds()
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
String	getProcessInstanceId()
String[]	getProcessInstanceIds()
QueryVariableValue	getQueryVariableValue()
String[]	getTaskIds()
String	getVariableName()
String	getVariableNameLike()
HistoricVariableInstanceQuery	includeDeleted() Include variables that has been already deleted during the execution
HistoricVariableInstanceQuery	orderByProcessInstanceId()
HistoricVariableInstanceQuery	orderByTenantId() Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
HistoricVariableInstanceQuery	orderByVariableName()
HistoricVariableInstanceQuery	processDefinitionId(String processDefinitionId) Only select historic process variables for the given process definition
HistoricVariableInstanceQuery	processDefinitionKey(String processDefinitionKey) Only select historic process variables for the given process definition key
HistoricVariableInstanceQueryImpl	processInstanceId(String processInstanceId) Only select historic process variables with the given process instance.
HistoricVariableInstanceQuery	processInstanceIdIn(String... processInstanceIds) Only select historic process variables with the given process instance ids.
protected boolean	shouldFetchValue(HistoricVariableInstanceEntity entity)
HistoricVariableInstanceQuery	taskIdIn(String... taskIds) Only select historic variable instances which have one of the task ids.
HistoricVariableInstanceQuery	tenantIdIn(String... tenantIds) Only select historic variable instances with one of the given tenant ids.
HistoricVariableInstanceQuery	variableId(String id) Only select the variable with the given Id
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	variableTypeIn(String... variableTypes) Only select historic process variables which match one of the given variable types.
HistoricVariableInstanceQuery	variableValueEquals(String variableName, Object variableValue) only select historic process variables with the given name and value

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

addExpression, addValidator, asc, checkMaxResultsLimit, checkQueryOk, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeIdsList, executeResult, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unboundedResultList, validate, validate

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.camunda.bpm.engine.query.Query

asc, count, desc, list, listPage, singleResult

Field Detail

variableId

protected String variableId

processInstanceId

protected String processInstanceId

processDefinitionId

protected String processDefinitionId

processDefinitionKey

protected String processDefinitionKey

caseInstanceId

protected String caseInstanceId

variableName

protected String variableName

variableNameLike

protected String variableNameLike

queryVariableValue

protected QueryVariableValue queryVariableValue

variableTypes

protected String[] variableTypes

taskIds

protected String[] taskIds

executionIds

protected String[] executionIds

caseExecutionIds

protected String[] caseExecutionIds

caseActivityIds

protected String[] caseActivityIds

activityInstanceIds

protected String[] activityInstanceIds

tenantIds

protected String[] tenantIds

processInstanceIds

protected String[] processInstanceIds

includeDeleted

protected boolean includeDeleted

isByteArrayFetchingEnabled

protected boolean isByteArrayFetchingEnabled

isCustomObjectDeserializationEnabled

protected boolean isCustomObjectDeserializationEnabled

Constructor Detail

HistoricVariableInstanceQueryImpl

public HistoricVariableInstanceQueryImpl()

HistoricVariableInstanceQueryImpl

public HistoricVariableInstanceQueryImpl(CommandExecutor commandExecutor)

Method Detail

variableId

public HistoricVariableInstanceQuery variableId(String id)

Description copied from interface: HistoricVariableInstanceQuery

Only select the variable with the given Id

Specified by:

variableId in interface HistoricVariableInstanceQuery

Returns:

the query object

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

processDefinitionId

public HistoricVariableInstanceQuery processDefinitionId(String processDefinitionId)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic process variables for the given process definition

Specified by:

processDefinitionId in interface HistoricVariableInstanceQuery

processDefinitionKey

public HistoricVariableInstanceQuery processDefinitionKey(String processDefinitionKey)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic process variables for the given process definition key

Specified by:

processDefinitionKey in interface HistoricVariableInstanceQuery

caseInstanceId

public HistoricVariableInstanceQuery caseInstanceId(String caseInstanceId)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic case variables with the given case instance.

Specified by:

caseInstanceId in interface HistoricVariableInstanceQuery

variableTypeIn

public HistoricVariableInstanceQuery variableTypeIn(String... variableTypes)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic process variables which match one of the given variable types.

Specified by:

variableTypeIn in interface HistoricVariableInstanceQuery

processInstanceIdIn

public HistoricVariableInstanceQuery processInstanceIdIn(String... processInstanceIds)

Only select historic process variables with the given process instance ids.

Specified by:

processInstanceIdIn in interface HistoricVariableInstanceQuery

taskIdIn

public HistoricVariableInstanceQuery taskIdIn(String... taskIds)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic variable instances which have one of the task ids.

Specified by:

taskIdIn in interface HistoricVariableInstanceQuery

executionIdIn

public HistoricVariableInstanceQuery executionIdIn(String... executionIds)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic variable instances which have one of the executions ids.

Specified by:

executionIdIn in interface HistoricVariableInstanceQuery

caseExecutionIdIn

public HistoricVariableInstanceQuery caseExecutionIdIn(String... caseExecutionIds)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic variable instances which have one of the case executions ids.

Specified by:

caseExecutionIdIn in interface HistoricVariableInstanceQuery

caseActivityIdIn

public HistoricVariableInstanceQuery caseActivityIdIn(String... caseActivityIds)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic variable instances with one of the given case activity ids.

Specified by:

caseActivityIdIn in interface HistoricVariableInstanceQuery

activityInstanceIdIn

public HistoricVariableInstanceQuery activityInstanceIdIn(String... activityInstanceIds)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic variable instances which have one of the activity instance ids.

Specified by:

activityInstanceIdIn 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

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

ensureVariablesInitialized

protected void ensureVariablesInitialized()

disableBinaryFetching

public HistoricVariableInstanceQuery disableBinaryFetching()

Description copied from interface: HistoricVariableInstanceQuery

Disable fetching of byte array and file values. By default, the query will fetch such values. By calling this method you can prevent the values of (potentially large) blob data chunks to be fetched. The variables themselves are nonetheless included in the query result.

Specified by:

disableBinaryFetching in interface HistoricVariableInstanceQuery

Returns:

the query builder

disableCustomObjectDeserialization

public HistoricVariableInstanceQuery disableCustomObjectDeserialization()

Description copied from interface: HistoricVariableInstanceQuery

Disable deserialization of variable values that are custom objects. By default, the query will attempt to deserialize the value of these variables. By calling this method you can prevent such attempts in environments where their classes are not available. Independent of this setting, variable serialized values are accessible.

Specified by:

disableCustomObjectDeserialization in interface HistoricVariableInstanceQuery

tenantIdIn

public HistoricVariableInstanceQuery tenantIdIn(String... tenantIds)

Description copied from interface: HistoricVariableInstanceQuery

Only select historic variable instances with one of the given tenant ids.

Specified by:

tenantIdIn in interface HistoricVariableInstanceQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<HistoricVariableInstanceQuery,HistoricVariableInstance>

executeList

public List<HistoricVariableInstance> executeList(CommandContext commandContext,
                                                  Page page)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<HistoricVariableInstanceQuery,HistoricVariableInstance>

page - used if the results must be paged. If null, no paging will be applied.

shouldFetchValue

protected boolean shouldFetchValue(HistoricVariableInstanceEntity entity)

orderByProcessInstanceId

public HistoricVariableInstanceQuery orderByProcessInstanceId()

Specified by:

orderByProcessInstanceId in interface HistoricVariableInstanceQuery

orderByVariableName

public HistoricVariableInstanceQuery orderByVariableName()

Specified by:

orderByVariableName in interface HistoricVariableInstanceQuery

orderByTenantId

public HistoricVariableInstanceQuery orderByTenantId()

Description copied from interface: HistoricVariableInstanceQuery

Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of historic variable instances without tenant id is database-specific.

Specified by:

orderByTenantId in interface HistoricVariableInstanceQuery

getProcessInstanceId

public String getProcessInstanceId()

getCaseInstanceId

public String getCaseInstanceId()

getActivityInstanceIds

public String[] getActivityInstanceIds()

getProcessInstanceIds

public String[] getProcessInstanceIds()

getTaskIds

public String[] getTaskIds()

getExecutionIds

public String[] getExecutionIds()

getCaseExecutionIds

public String[] getCaseExecutionIds()

getCaseActivityIds

public String[] getCaseActivityIds()

getVariableName

public String getVariableName()

getVariableNameLike

public String getVariableNameLike()

getQueryVariableValue

public QueryVariableValue getQueryVariableValue()

includeDeleted

public HistoricVariableInstanceQuery includeDeleted()

Description copied from interface: HistoricVariableInstanceQuery

Include variables that has been already deleted during the execution

Specified by:

includeDeleted in interface HistoricVariableInstanceQuery

getProcessDefinitionId

public String getProcessDefinitionId()

getProcessDefinitionKey

public String getProcessDefinitionKey()