HistoricProcessInstanceQuery (camunda BPM Javadocs 7.5.9-ee)

All Superinterfaces:

Query<HistoricProcessInstanceQuery,HistoricProcessInstance>

All Known Implementing Classes:

HistoricProcessInstanceQueryImpl
```
public interface HistoricProcessInstanceQuery
extends Query<HistoricProcessInstanceQuery,HistoricProcessInstance>
```
Allows programmatic querying of HistoricProcessInstances.

Author:

Tom Baeyens, Joram Barrez, Falko Menge

Method Summary

Methods
Modifier and Type	Method and Description
`HistoricProcessInstanceQuery`	`caseInstanceId(String caseInstanceId)` Only select historic process instances which are associated with the given case instance id.
`HistoricProcessInstanceQuery`	`finishDateBy(Date date)` Deprecated. use `startedAfter(Date)` and `startedBefore(Date)` instead
`HistoricProcessInstanceQuery`	`finishDateOn(Date date)` Deprecated. use `startedAfter(Date)` and `startedBefore(Date)` instead
`HistoricProcessInstanceQuery`	`finished()` Only select historic process instances that are completely finished.
`HistoricProcessInstanceQuery`	`finishedAfter(Date date)` Only select historic process instances that were started after the given date.
`HistoricProcessInstanceQuery`	`finishedBefore(Date date)` Only select historic process instances that were started before the given date.
`HistoricProcessInstanceQuery`	`incidentMessage(String incidentMessage)` Only select historic process instances with the given incident message.
`HistoricProcessInstanceQuery`	`incidentMessageLike(String incidentMessageLike)` Only select historic process instances which had an incident message like the given value.
`HistoricProcessInstanceQuery`	`orderByProcessDefinitionId()` Order by the process definition id (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByProcessInstanceBusinessKey()` Order by the business key (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByProcessInstanceDuration()` Order by the duration of the process instance (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByProcessInstanceEndTime()` Order by the end time (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByProcessInstanceId()` Order by the process instance id (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByProcessInstanceStartTime()` Order by the start time (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`orderByTenantId()` Order by tenant id (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricProcessInstanceQuery`	`processDefinitionId(String processDefinitionId)` Only select historic process instances for the given process definition
`HistoricProcessInstanceQuery`	`processDefinitionKey(String processDefinitionKey)` Only select historic process instances that are defined by a process definition with the given key.
`HistoricProcessInstanceQuery`	`processDefinitionKeyNotIn(List<String> processDefinitionKeys)` Only select historic process instances that don't have a process-definition of which the key is present in the given list
`HistoricProcessInstanceQuery`	`processDefinitionName(String processDefinitionName)` Only select historic process instances that are defined by a process definition with the given name.
`HistoricProcessInstanceQuery`	`processDefinitionNameLike(String nameLike)` Only select historic process instances that are defined by process definition which name is like the given value.
`HistoricProcessInstanceQuery`	`processInstanceBusinessKey(String processInstanceBusinessKey)` Only select historic process instances with the given business key
`HistoricProcessInstanceQuery`	`processInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)` Only select historic process instances which had a business key like the given value.
`HistoricProcessInstanceQuery`	`processInstanceId(String processInstanceId)` Only select historic process instances with the given process instance.
`HistoricProcessInstanceQuery`	`processInstanceIds(Set<String> processInstanceIds)` Only select historic process instances whose id is in the given set of ids.
`HistoricProcessInstanceQuery`	`startDateBy(Date date)` Deprecated. use `startedAfter(Date)` and `startedBefore(Date)` instead
`HistoricProcessInstanceQuery`	`startDateOn(Date date)` Deprecated. use `startedAfter(Date)` and `startedBefore(Date)` instead
`HistoricProcessInstanceQuery`	`startedAfter(Date date)` Only select historic process instances that were started after the given date.
`HistoricProcessInstanceQuery`	`startedBefore(Date date)` Only select historic process instances that were started before the given date.
`HistoricProcessInstanceQuery`	`startedBy(String userId)` Only select historic process instance that are started by the given user.
`HistoricProcessInstanceQuery`	`subCaseInstanceId(String subCaseInstanceId)` Only select historic process instances having a sub case instance with the given case instance id.
`HistoricProcessInstanceQuery`	`subProcessInstanceId(String subProcessInstanceId)` Only select historic process instances having a sub process instance with the given process instance id.
`HistoricProcessInstanceQuery`	`superCaseInstanceId(String superCaseInstanceId)` Only select historic process instances started by the given case instance.
`HistoricProcessInstanceQuery`	`superProcessInstanceId(String superProcessInstanceId)` Only select historic process instances started by the given process instance.
`HistoricProcessInstanceQuery`	`tenantIdIn(String... tenantIds)` Only select historic process instances with one of the given tenant ids.
`HistoricProcessInstanceQuery`	`unfinished()` Only select historic process instance that are not yet finished.
`HistoricProcessInstanceQuery`	`variableValueEquals(String name, Object value)` Only select process instances which had a global variable with the given value when they ended.
`HistoricProcessInstanceQuery`	`variableValueGreaterThan(String name, Object value)` Only select process instances which had a global variable value greater than the passed value when they ended.
`HistoricProcessInstanceQuery`	`variableValueGreaterThanOrEqual(String name, Object value)` Only select process instances which had a global variable value greater than or equal to the passed value when they ended.
`HistoricProcessInstanceQuery`	`variableValueLessThan(String name, Object value)` Only select process instances which had a global variable value less than the passed value when the ended.
`HistoricProcessInstanceQuery`	`variableValueLessThanOrEqual(String name, Object value)` Only select process instances which has a global variable value less than or equal to the passed value when they ended.
`HistoricProcessInstanceQuery`	`variableValueLike(String name, String value)` Only select process instances which had global variable value like the given value when they ended.
`HistoricProcessInstanceQuery`	`variableValueNotEquals(String name, Object value)` Only select process instances which had a global variable with the given name, but with a different value than the passed value when they ended.
`HistoricProcessInstanceQuery`	`withIncidents()` Only select historic process instances with incidents

Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult

- Method Detail
  - processInstanceId
```
HistoricProcessInstanceQuery processInstanceId(String processInstanceId)
```
    Only select historic process instances with the given process instance. ProcessInstance) ids and {@link HistoricProcessInstance} ids match.
  - processInstanceIds
```
HistoricProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
```
    Only select historic process instances whose id is in the given set of ids. ProcessInstance) ids and {@link HistoricProcessInstance} ids match.
  - processDefinitionId
```
HistoricProcessInstanceQuery processDefinitionId(String processDefinitionId)
```
    Only select historic process instances for the given process definition
  - processDefinitionKey
```
HistoricProcessInstanceQuery processDefinitionKey(String processDefinitionKey)
```
    Only select historic process instances that are defined by a process definition with the given key.
  - processDefinitionKeyNotIn
```
HistoricProcessInstanceQuery processDefinitionKeyNotIn(List<String> processDefinitionKeys)
```
    Only select historic process instances that don't have a process-definition of which the key is present in the given list
  - processDefinitionName
```
HistoricProcessInstanceQuery processDefinitionName(String processDefinitionName)
```
    Only select historic process instances that are defined by a process definition with the given name.
  - processDefinitionNameLike
```
HistoricProcessInstanceQuery processDefinitionNameLike(String nameLike)
```
    Only select historic process instances that are defined by process definition which name is like the given value.
    
    Parameters:
    nameLike - The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
  - processInstanceBusinessKey
```
HistoricProcessInstanceQuery processInstanceBusinessKey(String processInstanceBusinessKey)
```
    Only select historic process instances with the given business key
  - processInstanceBusinessKeyLike
```
HistoricProcessInstanceQuery processInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)
```
    Only select historic process instances which had a business key like the given value.
    
    Parameters:
    processInstanceBusinessKeyLike - The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
  - finished
```
HistoricProcessInstanceQuery finished()
```
    Only select historic process instances that are completely finished.
  - unfinished
```
HistoricProcessInstanceQuery unfinished()
```
    Only select historic process instance that are not yet finished.
  - withIncidents
```
HistoricProcessInstanceQuery withIncidents()
```
    Only select historic process instances with incidents
    
    Returns:
    HistoricProcessInstanceQuery
  - incidentMessage
```
HistoricProcessInstanceQuery incidentMessage(String incidentMessage)
```
    Only select historic process instances with the given incident message.
    
    Parameters:
    incidentMessage - Incidents Message for which the historic process instances should be selected
    
    Returns:
    HistoricProcessInstanceQuery
  - incidentMessageLike
```
HistoricProcessInstanceQuery incidentMessageLike(String incidentMessageLike)
```
    Only select historic process instances which had an incident message like the given value.
    
    Parameters:
    incidentMessageLike - The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
    
    Returns:
    HistoricProcessInstanceQuery
  - caseInstanceId
```
HistoricProcessInstanceQuery caseInstanceId(String caseInstanceId)
```
    Only select historic process instances which are associated with the given case instance id.
  - variableValueEquals
```
HistoricProcessInstanceQuery variableValueEquals(String name,
                                               Object value)
```
    Only select process instances which had a global variable with the given value when they ended. Only select process instances which have a variable value greater than the passed value. The type only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableSerializers(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    name - of the variable, cannot be null.
  - variableValueNotEquals
```
HistoricProcessInstanceQuery variableValueNotEquals(String name,
                                                  Object value)
```
    Only select process instances which had a global variable with the given name, but with a different value than the passed value when they ended. Only select process instances which have a variable value greater than the passed value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    name - of the variable, cannot be null.
  - variableValueGreaterThan
```
HistoricProcessInstanceQuery variableValueGreaterThan(String name,
                                                    Object value)
```
    Only select process instances which had a global variable value greater than the passed value when they ended. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported. Only select process instances which have a variable value greater than the passed value.
    
    Parameters:
    name - cannot be null.
    value - cannot be null.
  - variableValueGreaterThanOrEqual
```
HistoricProcessInstanceQuery variableValueGreaterThanOrEqual(String name,
                                                           Object value)
```
    Only select process instances which had a global variable value greater than or equal to the passed value when they ended. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead!
    
    Parameters:
    name - cannot be null.
    value - cannot be null.
  - variableValueLessThan
```
HistoricProcessInstanceQuery variableValueLessThan(String name,
                                                 Object value)
```
    Only select process instances which had a global variable value less than the passed value when the ended. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    name - cannot be null.
    value - cannot be null.
  - variableValueLessThanOrEqual
```
HistoricProcessInstanceQuery variableValueLessThanOrEqual(String name,
                                                        Object value)
```
    Only select process instances which has a global variable value less than or equal to the passed value when they ended. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    name - cannot be null.
    value - cannot be null.
  - variableValueLike
```
HistoricProcessInstanceQuery variableValueLike(String name,
                                             String value)
```
    Only select process instances which had global variable value like the given value when they ended. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! This can be used on string variables only.
    
    Parameters:
    name - cannot be null.
    value - cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
  - startedBefore
```
HistoricProcessInstanceQuery startedBefore(Date date)
```
    Only select historic process instances that were started before the given date.
  - startedAfter
```
HistoricProcessInstanceQuery startedAfter(Date date)
```
    Only select historic process instances that were started after the given date.
  - finishedBefore
```
HistoricProcessInstanceQuery finishedBefore(Date date)
```
    Only select historic process instances that were started before the given date.
  - finishedAfter
```
HistoricProcessInstanceQuery finishedAfter(Date date)
```
    Only select historic process instances that were started after the given date.
  - startedBy
```
HistoricProcessInstanceQuery startedBy(String userId)
```
    Only select historic process instance that are started by the given user.
  - orderByProcessInstanceId
```
HistoricProcessInstanceQuery orderByProcessInstanceId()
```
    Order by the process instance id (needs to be followed by Query.asc() or Query.desc()).
  - orderByProcessDefinitionId
```
HistoricProcessInstanceQuery orderByProcessDefinitionId()
```
    Order by the process definition id (needs to be followed by Query.asc() or Query.desc()).
  - orderByProcessInstanceBusinessKey
```
HistoricProcessInstanceQuery orderByProcessInstanceBusinessKey()
```
    Order by the business key (needs to be followed by Query.asc() or Query.desc()).
  - orderByProcessInstanceStartTime
```
HistoricProcessInstanceQuery orderByProcessInstanceStartTime()
```
    Order by the start time (needs to be followed by Query.asc() or Query.desc()).
  - orderByProcessInstanceEndTime
```
HistoricProcessInstanceQuery orderByProcessInstanceEndTime()
```
    Order by the end time (needs to be followed by Query.asc() or Query.desc()).
  - orderByProcessInstanceDuration
```
HistoricProcessInstanceQuery orderByProcessInstanceDuration()
```
    Order by the duration of the process instance (needs to be followed by Query.asc() or Query.desc()).
  - superProcessInstanceId
```
HistoricProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)
```
    Only select historic process instances started by the given process instance. ProcessInstance) ids and {@link HistoricProcessInstance} ids match.
  - subProcessInstanceId
```
HistoricProcessInstanceQuery subProcessInstanceId(String subProcessInstanceId)
```
    Only select historic process instances having a sub process instance with the given process instance id. Note that there will always be maximum only one such process instance that can be the result of this query.
  - superCaseInstanceId
```
HistoricProcessInstanceQuery superCaseInstanceId(String superCaseInstanceId)
```
    Only select historic process instances started by the given case instance.
  - subCaseInstanceId
```
HistoricProcessInstanceQuery subCaseInstanceId(String subCaseInstanceId)
```
    Only select historic process instances having a sub case instance with the given case instance id. Note that there will always be maximum only one such process instance that can be the result of this query.
  - tenantIdIn
```
HistoricProcessInstanceQuery tenantIdIn(String... tenantIds)
```
    Only select historic process instances with one of the given tenant ids.
  - orderByTenantId
```
HistoricProcessInstanceQuery orderByTenantId()
```
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of historic process instances without tenant id is database-specific.
  - startDateBy
```
@Deprecated
HistoricProcessInstanceQuery startDateBy(Date date)
```
    Deprecated. use startedAfter(Date) and startedBefore(Date) instead
    
    Only select historic process instances that were started as of the provided date. (Date will be adjusted to reflect midnight)
  - startDateOn
```
@Deprecated
HistoricProcessInstanceQuery startDateOn(Date date)
```
    Deprecated. use startedAfter(Date) and startedBefore(Date) instead
    
    Only select historic process instances that were started on the provided date.
  - finishDateBy
```
@Deprecated
HistoricProcessInstanceQuery finishDateBy(Date date)
```
    Deprecated. use startedAfter(Date) and startedBefore(Date) instead
    
    Only select historic process instances that were finished as of the provided date. (Date will be adjusted to reflect one second before midnight)
  - finishDateOn
```
@Deprecated
HistoricProcessInstanceQuery finishDateOn(Date date)
```
    Deprecated. use startedAfter(Date) and startedBefore(Date) instead
    
    Only select historic process instances that were finished on provided date.

Interface HistoricProcessInstanceQuery

Method Summary

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

Method Detail

processInstanceId

processInstanceIds

processDefinitionId

processDefinitionKey

processDefinitionKeyNotIn

processDefinitionName

processDefinitionNameLike

processInstanceBusinessKey

processInstanceBusinessKeyLike

finished

unfinished

withIncidents

incidentMessage

incidentMessageLike

caseInstanceId

variableValueEquals

variableValueNotEquals

variableValueGreaterThan

variableValueGreaterThanOrEqual

variableValueLessThan

variableValueLessThanOrEqual

variableValueLike

startedBefore

startedAfter

finishedBefore

finishedAfter

startedBy

orderByProcessInstanceId

orderByProcessDefinitionId

orderByProcessInstanceBusinessKey

orderByProcessInstanceStartTime

orderByProcessInstanceEndTime

orderByProcessInstanceDuration

superProcessInstanceId

subProcessInstanceId

superCaseInstanceId

subCaseInstanceId

tenantIdIn

orderByTenantId

startDateBy

startDateOn

finishDateBy

finishDateOn