Package 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:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery
AbstractQuery.ResultType
-
Field Summary
Modifier and TypeFieldDescriptionprotected String[]
protected String[]
protected String[]
protected String
protected String[]
protected boolean
protected boolean
protected boolean
protected boolean
protected String
protected String
protected String
protected String[]
protected QueryVariableValue
protected String[]
protected String[]
protected String
protected String
protected String
protected Boolean
protected String[]
protected Boolean
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
-
Method Summary
Modifier and TypeMethodDescriptionactivityInstanceIdIn
(String... activityInstanceIds) Only select historic variable instances which have one of the activity instance ids.caseActivityIdIn
(String... caseActivityIds) Only select historic variable instances with one of the given case activity ids.caseExecutionIdIn
(String... caseExecutionIds) Only select historic variable instances which have one of the case executions ids.caseInstanceId
(String caseInstanceId) Only select historic case variables with the given case instance.Disable fetching of byte array and file values.Disable deserialization of variable values that are custom objects.protected void
long
executeCount
(CommandContext commandContext) executeList
(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.executionIdIn
(String... executionIds) Only select historic variable instances which have one of the executions ids.String[]
String[]
String[]
String[]
String[]
String[]
Include variables that has been already deleted during the executionboolean
The query will match the names of task and process variables in a case-insensitive way.The query will match the values of task and process variables in a case-insensitive way.Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).processDefinitionId
(String processDefinitionId) Only select historic process variables for the given process definitionprocessDefinitionKey
(String processDefinitionKey) Only select historic process variables for the given process definition keyprocessInstanceId
(String processInstanceId) Only select historic process variables with the given process instance.processInstanceIdIn
(String... processInstanceIds) Only select historic process variables with the given process instance ids.protected boolean
Only select historic variable instances which have one of the task ids.tenantIdIn
(String... tenantIds) Only select historic variable instances with one of the given tenant ids.variableId
(String id) Only select the variable with the given IdvariableName
(String variableName) Only select historic process variables with the given variable name.variableNameIn
(String... names) Only select historic process variables with the given variable names.variableNameLike
(String variableNameLike) Only select historic process variables where the given variable name is like.variableTypeIn
(String... variableTypes) Only select historic process variables which match one of the given variable types.variableValueEquals
(String variableName, Object variableValue) only select historic process variables with the given name and valueOnly selects historic variable instances that have no tenant id.Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery
addExpression, addValidator, asc, checkMaxResultsLimit, checkQueryOk, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteDeploymentIdMappingsList, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeDeploymentIdMappingsList, executeIdsList, executeResult, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listDeploymentIdMappings, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unlimitedList, 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, unlimitedList
-
Field Details
-
variableNameIn
-
variableId
-
processInstanceId
-
processDefinitionId
-
processDefinitionKey
-
caseInstanceId
-
variableName
-
variableNameLike
-
queryVariableValue
-
variableNamesIgnoreCase
-
variableValuesIgnoreCase
-
variableTypes
-
taskIds
-
executionIds
-
caseExecutionIds
-
caseActivityIds
-
activityInstanceIds
-
tenantIds
-
isTenantIdSet
protected boolean isTenantIdSet -
processInstanceIds
-
includeDeleted
protected boolean includeDeleted -
isByteArrayFetchingEnabled
protected boolean isByteArrayFetchingEnabled -
isCustomObjectDeserializationEnabled
protected boolean isCustomObjectDeserializationEnabled
-
-
Constructor Details
-
HistoricVariableInstanceQueryImpl
public HistoricVariableInstanceQueryImpl() -
HistoricVariableInstanceQueryImpl
-
-
Method Details
-
variableNameIn
Description copied from interface:HistoricVariableInstanceQuery
Only select historic process variables with the given variable names.- Specified by:
variableNameIn
in interfaceHistoricVariableInstanceQuery
-
variableId
Description copied from interface:HistoricVariableInstanceQuery
Only select the variable with the given Id- Specified by:
variableId
in interfaceHistoricVariableInstanceQuery
- Parameters:
id
- of the variable to select- Returns:
- the query object
-
processInstanceId
Description copied from interface:HistoricVariableInstanceQuery
Only select historic process variables with the given process instance.- Specified by:
processInstanceId
in interfaceHistoricVariableInstanceQuery
-
processDefinitionId
Description copied from interface:HistoricVariableInstanceQuery
Only select historic process variables for the given process definition- Specified by:
processDefinitionId
in interfaceHistoricVariableInstanceQuery
-
processDefinitionKey
Description copied from interface:HistoricVariableInstanceQuery
Only select historic process variables for the given process definition key- Specified by:
processDefinitionKey
in interfaceHistoricVariableInstanceQuery
-
caseInstanceId
Description copied from interface:HistoricVariableInstanceQuery
Only select historic case variables with the given case instance.- Specified by:
caseInstanceId
in interfaceHistoricVariableInstanceQuery
-
variableTypeIn
Description copied from interface:HistoricVariableInstanceQuery
Only select historic process variables which match one of the given variable types.- Specified by:
variableTypeIn
in interfaceHistoricVariableInstanceQuery
-
matchVariableNamesIgnoreCase
Description copied from interface:HistoricVariableInstanceQuery
The query will match the names of task and process variables in a case-insensitive way.- Specified by:
matchVariableNamesIgnoreCase
in interfaceHistoricVariableInstanceQuery
-
matchVariableValuesIgnoreCase
Description copied from interface:HistoricVariableInstanceQuery
The query will match the values of task and process variables in a case-insensitive way.- Specified by:
matchVariableValuesIgnoreCase
in interfaceHistoricVariableInstanceQuery
-
processInstanceIdIn
Only select historic process variables with the given process instance ids.- Specified by:
processInstanceIdIn
in interfaceHistoricVariableInstanceQuery
-
taskIdIn
Description copied from interface:HistoricVariableInstanceQuery
Only select historic variable instances which have one of the task ids.- Specified by:
taskIdIn
in interfaceHistoricVariableInstanceQuery
-
executionIdIn
Description copied from interface:HistoricVariableInstanceQuery
Only select historic variable instances which have one of the executions ids.- Specified by:
executionIdIn
in interfaceHistoricVariableInstanceQuery
-
caseExecutionIdIn
Description copied from interface:HistoricVariableInstanceQuery
Only select historic variable instances which have one of the case executions ids.- Specified by:
caseExecutionIdIn
in interfaceHistoricVariableInstanceQuery
-
caseActivityIdIn
Description copied from interface:HistoricVariableInstanceQuery
Only select historic variable instances with one of the given case activity ids.- Specified by:
caseActivityIdIn
in interfaceHistoricVariableInstanceQuery
-
activityInstanceIdIn
Description copied from interface:HistoricVariableInstanceQuery
Only select historic variable instances which have one of the activity instance ids.- Specified by:
activityInstanceIdIn
in interfaceHistoricVariableInstanceQuery
-
variableName
Description copied from interface:HistoricVariableInstanceQuery
Only select historic process variables with the given variable name.- Specified by:
variableName
in interfaceHistoricVariableInstanceQuery
-
variableValueEquals
Description copied from interface:HistoricVariableInstanceQuery
only select historic process variables with the given name and value- Specified by:
variableValueEquals
in interfaceHistoricVariableInstanceQuery
-
variableNameLike
Description copied from interface:HistoricVariableInstanceQuery
Only select historic process variables where the given variable name is like.- Specified by:
variableNameLike
in interfaceHistoricVariableInstanceQuery
-
ensureVariablesInitialized
protected void ensureVariablesInitialized() -
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 interfaceHistoricVariableInstanceQuery
- Returns:
- the query builder
-
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 interfaceHistoricVariableInstanceQuery
-
tenantIdIn
Description copied from interface:HistoricVariableInstanceQuery
Only select historic variable instances with one of the given tenant ids.- Specified by:
tenantIdIn
in interfaceHistoricVariableInstanceQuery
-
withoutTenantId
Description copied from interface:HistoricVariableInstanceQuery
Only selects historic variable instances that have no tenant id.- Specified by:
withoutTenantId
in interfaceHistoricVariableInstanceQuery
-
executeCount
- Specified by:
executeCount
in classAbstractQuery<HistoricVariableInstanceQuery,
HistoricVariableInstance>
-
executeList
Description copied from class:AbstractQuery
Executes the actual query to retrieve the list of results.- Specified by:
executeList
in classAbstractQuery<HistoricVariableInstanceQuery,
HistoricVariableInstance> page
- used if the results must be paged. If null, no paging will be applied.
-
shouldFetchValue
-
orderByProcessInstanceId
- Specified by:
orderByProcessInstanceId
in interfaceHistoricVariableInstanceQuery
-
orderByVariableName
- Specified by:
orderByVariableName
in interfaceHistoricVariableInstanceQuery
-
orderByTenantId
Description copied from interface:HistoricVariableInstanceQuery
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). Note that the ordering of historic variable instances without tenant id is database-specific.- Specified by:
orderByTenantId
in interfaceHistoricVariableInstanceQuery
-
getProcessInstanceId
-
getCaseInstanceId
-
getActivityInstanceIds
-
getProcessInstanceIds
-
getTaskIds
-
getExecutionIds
-
getCaseExecutionIds
-
getCaseActivityIds
-
isTenantIdSet
public boolean isTenantIdSet() -
getVariableName
-
getVariableNameLike
-
getQueryVariableValue
-
getVariableNamesIgnoreCase
-
getVariableValuesIgnoreCase
-
includeDeleted
Description copied from interface:HistoricVariableInstanceQuery
Include variables that has been already deleted during the execution- Specified by:
includeDeleted
in interfaceHistoricVariableInstanceQuery
-
getProcessDefinitionId
-
getProcessDefinitionKey
-
getVariableNameIn
-