Package org.camunda.bpm.engine.history
Interface HistoricVariableInstanceQuery
-
- All Superinterfaces:
Query<HistoricVariableInstanceQuery,HistoricVariableInstance>
- All Known Implementing Classes:
HistoricVariableInstanceQueryImpl
public interface HistoricVariableInstanceQuery extends Query<HistoricVariableInstanceQuery,HistoricVariableInstance>
Programmatic querying forHistoricVariableInstance
s.- Author:
- Christian Lipphardt (camunda)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.HistoricVariableInstanceQuery
executionIdIn(String... executionIds)
Only select historic variable instances which have one of the executions ids.HistoricVariableInstanceQuery
includeDeleted()
Include variables that has been already deleted during the executionHistoricVariableInstanceQuery
matchVariableNamesIgnoreCase()
The query will match the names of task and process variables in a case-insensitive way.HistoricVariableInstanceQuery
matchVariableValuesIgnoreCase()
The query will match the values of task and process variables in a case-insensitive way.HistoricVariableInstanceQuery
orderByProcessInstanceId()
HistoricVariableInstanceQuery
orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).HistoricVariableInstanceQuery
orderByVariableName()
HistoricVariableInstanceQuery
processDefinitionId(String processDefinitionId)
Only select historic process variables for the given process definitionHistoricVariableInstanceQuery
processDefinitionKey(String processDefinitionKey)
Only select historic process variables for the given process definition keyHistoricVariableInstanceQuery
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.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 IdHistoricVariableInstanceQuery
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 valueHistoricVariableInstanceQuery
withoutTenantId()
Only selects historic variable instances that have no tenant id.-
Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
-
-
-
Method Detail
-
variableId
HistoricVariableInstanceQuery variableId(String id)
Only select the variable with the given Id- Parameters:
id
- of the variable to select- Returns:
- the query object
-
processInstanceId
HistoricVariableInstanceQuery processInstanceId(String processInstanceId)
Only select historic process variables with the given process instance.
-
processDefinitionId
HistoricVariableInstanceQuery processDefinitionId(String processDefinitionId)
Only select historic process variables for the given process definition
-
processDefinitionKey
HistoricVariableInstanceQuery processDefinitionKey(String processDefinitionKey)
Only select historic process variables for the given process definition key
-
caseInstanceId
HistoricVariableInstanceQuery caseInstanceId(String caseInstanceId)
Only select historic case variables with the given case instance.
-
variableName
HistoricVariableInstanceQuery variableName(String variableName)
Only select historic process variables with the given variable name.
-
variableNameLike
HistoricVariableInstanceQuery variableNameLike(String variableNameLike)
Only select historic process variables where the given variable name is like.
-
variableTypeIn
HistoricVariableInstanceQuery variableTypeIn(String... variableTypes)
Only select historic process variables which match one of the given variable types.
-
matchVariableNamesIgnoreCase
HistoricVariableInstanceQuery matchVariableNamesIgnoreCase()
The query will match the names of task and process variables in a case-insensitive way.
-
matchVariableValuesIgnoreCase
HistoricVariableInstanceQuery matchVariableValuesIgnoreCase()
The query will match the values of task and process variables in a case-insensitive way.
-
variableValueEquals
HistoricVariableInstanceQuery variableValueEquals(String variableName, Object variableValue)
only select historic process variables with the given name and value
-
orderByProcessInstanceId
HistoricVariableInstanceQuery orderByProcessInstanceId()
-
orderByVariableName
HistoricVariableInstanceQuery orderByVariableName()
-
processInstanceIdIn
HistoricVariableInstanceQuery processInstanceIdIn(String... processInstanceIds)
Only select historic process variables with the given process instance ids.
-
taskIdIn
HistoricVariableInstanceQuery taskIdIn(String... taskIds)
Only select historic variable instances which have one of the task ids.
-
executionIdIn
HistoricVariableInstanceQuery executionIdIn(String... executionIds)
Only select historic variable instances which have one of the executions ids.
-
caseExecutionIdIn
HistoricVariableInstanceQuery caseExecutionIdIn(String... caseExecutionIds)
Only select historic variable instances which have one of the case executions ids.
-
caseActivityIdIn
HistoricVariableInstanceQuery caseActivityIdIn(String... caseActivityIds)
Only select historic variable instances with one of the given case activity ids.
-
activityInstanceIdIn
HistoricVariableInstanceQuery activityInstanceIdIn(String... activityInstanceIds)
Only select historic variable instances which have one of the activity instance ids.
-
tenantIdIn
HistoricVariableInstanceQuery tenantIdIn(String... tenantIds)
Only select historic variable instances with one of the given tenant ids.
-
withoutTenantId
HistoricVariableInstanceQuery withoutTenantId()
Only selects historic variable instances that have no tenant id.
-
orderByTenantId
HistoricVariableInstanceQuery orderByTenantId()
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.
-
disableBinaryFetching
HistoricVariableInstanceQuery disableBinaryFetching()
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.- Returns:
- the query builder
-
disableCustomObjectDeserialization
HistoricVariableInstanceQuery disableCustomObjectDeserialization()
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.
-
includeDeleted
HistoricVariableInstanceQuery includeDeleted()
Include variables that has been already deleted during the execution
-
-