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 forHistoricVariableInstances.- Author:
- Christian Lipphardt (camunda)
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description HistoricVariableInstanceQueryactivityInstanceIdIn(String... activityInstanceIds)Only select historic variable instances which have one of the activity instance ids.HistoricVariableInstanceQuerycaseActivityIdIn(String... caseActivityIds)Only select historic variable instances with one of the given case activity ids.HistoricVariableInstanceQuerycaseExecutionIdIn(String... caseExecutionIds)Only select historic variable instances which have one of the case executions ids.HistoricVariableInstanceQuerycaseInstanceId(String caseInstanceId)Only select historic case variables with the given case instance.HistoricVariableInstanceQuerydisableBinaryFetching()Disable fetching of byte array and file values.HistoricVariableInstanceQuerydisableCustomObjectDeserialization()Disable deserialization of variable values that are custom objects.HistoricVariableInstanceQueryexecutionIdIn(String... executionIds)Only select historic variable instances which have one of the executions ids.HistoricVariableInstanceQueryincludeDeleted()Include variables that has been already deleted during the executionHistoricVariableInstanceQuerymatchVariableNamesIgnoreCase()The query will match the names of task and process variables in a case-insensitive way.HistoricVariableInstanceQuerymatchVariableValuesIgnoreCase()The query will match the values of task and process variables in a case-insensitive way.HistoricVariableInstanceQueryorderByProcessInstanceId()HistoricVariableInstanceQueryorderByTenantId()Order by tenant id (needs to be followed byQuery.asc()orQuery.desc()).HistoricVariableInstanceQueryorderByVariableName()HistoricVariableInstanceQueryprocessDefinitionId(String processDefinitionId)Only select historic process variables for the given process definitionHistoricVariableInstanceQueryprocessDefinitionKey(String processDefinitionKey)Only select historic process variables for the given process definition keyHistoricVariableInstanceQueryprocessInstanceId(String processInstanceId)Only select historic process variables with the given process instance.HistoricVariableInstanceQueryprocessInstanceIdIn(String... processInstanceIds)Only select historic process variables with the given process instance ids.HistoricVariableInstanceQuerytaskIdIn(String... taskIds)Only select historic variable instances which have one of the task ids.HistoricVariableInstanceQuerytenantIdIn(String... tenantIds)Only select historic variable instances with one of the given tenant ids.HistoricVariableInstanceQueryvariableId(String id)Only select the variable with the given IdHistoricVariableInstanceQueryvariableName(String variableName)Only select historic process variables with the given variable name.HistoricVariableInstanceQueryvariableNameIn(String... names)Only select historic process variables with the given variable names.HistoricVariableInstanceQueryvariableNameLike(String variableNameLike)Only select historic process variables where the given variable name is like.HistoricVariableInstanceQueryvariableTypeIn(String... variableTypes)Only select historic process variables which match one of the given variable types.HistoricVariableInstanceQueryvariableValueEquals(String variableName, Object variableValue)only select historic process variables with the given name and valueHistoricVariableInstanceQuerywithoutTenantId()Only selects historic variable instances that have no tenant id.- 
Methods inherited from interface org.camunda.bpm.engine.query.Queryasc, count, desc, list, listPage, singleResult, unlimitedList
 
- 
 
- 
- 
- 
Method Detail- 
variableIdHistoricVariableInstanceQuery variableId(String id) Only select the variable with the given Id- Parameters:
- id- of the variable to select
- Returns:
- the query object
 
 - 
processInstanceIdHistoricVariableInstanceQuery processInstanceId(String processInstanceId) Only select historic process variables with the given process instance.
 - 
processDefinitionIdHistoricVariableInstanceQuery processDefinitionId(String processDefinitionId) Only select historic process variables for the given process definition
 - 
processDefinitionKeyHistoricVariableInstanceQuery processDefinitionKey(String processDefinitionKey) Only select historic process variables for the given process definition key
 - 
caseInstanceIdHistoricVariableInstanceQuery caseInstanceId(String caseInstanceId) Only select historic case variables with the given case instance.
 - 
variableNameHistoricVariableInstanceQuery variableName(String variableName) Only select historic process variables with the given variable name.
 - 
variableNameLikeHistoricVariableInstanceQuery variableNameLike(String variableNameLike) Only select historic process variables where the given variable name is like.
 - 
variableTypeInHistoricVariableInstanceQuery variableTypeIn(String... variableTypes) Only select historic process variables which match one of the given variable types.
 - 
matchVariableNamesIgnoreCaseHistoricVariableInstanceQuery matchVariableNamesIgnoreCase() The query will match the names of task and process variables in a case-insensitive way.
 - 
matchVariableValuesIgnoreCaseHistoricVariableInstanceQuery matchVariableValuesIgnoreCase() The query will match the values of task and process variables in a case-insensitive way.
 - 
variableValueEqualsHistoricVariableInstanceQuery variableValueEquals(String variableName, Object variableValue) only select historic process variables with the given name and value
 - 
orderByProcessInstanceIdHistoricVariableInstanceQuery orderByProcessInstanceId() 
 - 
orderByVariableNameHistoricVariableInstanceQuery orderByVariableName() 
 - 
processInstanceIdInHistoricVariableInstanceQuery processInstanceIdIn(String... processInstanceIds) Only select historic process variables with the given process instance ids.
 - 
taskIdInHistoricVariableInstanceQuery taskIdIn(String... taskIds) Only select historic variable instances which have one of the task ids.
 - 
executionIdInHistoricVariableInstanceQuery executionIdIn(String... executionIds) Only select historic variable instances which have one of the executions ids.
 - 
caseExecutionIdInHistoricVariableInstanceQuery caseExecutionIdIn(String... caseExecutionIds) Only select historic variable instances which have one of the case executions ids.
 - 
caseActivityIdInHistoricVariableInstanceQuery caseActivityIdIn(String... caseActivityIds) Only select historic variable instances with one of the given case activity ids.
 - 
activityInstanceIdInHistoricVariableInstanceQuery activityInstanceIdIn(String... activityInstanceIds) Only select historic variable instances which have one of the activity instance ids.
 - 
tenantIdInHistoricVariableInstanceQuery tenantIdIn(String... tenantIds) Only select historic variable instances with one of the given tenant ids.
 - 
withoutTenantIdHistoricVariableInstanceQuery withoutTenantId() Only selects historic variable instances that have no tenant id.
 - 
orderByTenantIdHistoricVariableInstanceQuery 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.
 - 
disableBinaryFetchingHistoricVariableInstanceQuery 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
 
 - 
disableCustomObjectDeserializationHistoricVariableInstanceQuery 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.
 - 
includeDeletedHistoricVariableInstanceQuery includeDeleted() Include variables that has been already deleted during the execution
 - 
variableNameInHistoricVariableInstanceQuery variableNameIn(String... names) Only select historic process variables with the given variable names.
 
- 
 
-