HistoricCaseInstanceQuery (Camunda BPM Javadocs 7.9.19-ee)

All Superinterfaces:

Query<HistoricCaseInstanceQuery,HistoricCaseInstance>

All Known Implementing Classes:

HistoricCaseInstanceQueryImpl
```
public interface HistoricCaseInstanceQuery
extends Query<HistoricCaseInstanceQuery,HistoricCaseInstance>
```
Allows programmatic querying of HistoricCaseInstances.

Author:

Tom Baeyens, Joram Barrez, Falko Menge

Method Summary

Methods
Modifier and Type	Method and Description
`HistoricCaseInstanceQuery`	`active()` Only select historic case instances which are active
`HistoricCaseInstanceQuery`	`caseActivityIdIn(String... caseActivityIds)` Only selects historic case instances with historic case activity instances in at least one of the given case activity ids.
`HistoricCaseInstanceQuery`	`caseDefinitionId(String caseDefinitionId)` Only select historic case instances for the given case definition
`HistoricCaseInstanceQuery`	`caseDefinitionKey(String caseDefinitionKey)` Only select historic case instances that are defined by a case definition with the given key.
`HistoricCaseInstanceQuery`	`caseDefinitionKeyNotIn(List<String> caseDefinitionKeys)` Only select historic case instances that don't have a case definition of which the key is present in the given list
`HistoricCaseInstanceQuery`	`caseDefinitionName(String caseDefinitionName)` Only select historic case instances that are defined by a case definition with the given name.
`HistoricCaseInstanceQuery`	`caseDefinitionNameLike(String nameLike)` Only select historic case instances that are defined by case definition which name is like the given value.
`HistoricCaseInstanceQuery`	`caseInstanceBusinessKey(String caseInstanceBusinessKey)` Only select historic case instances with the given business key
`HistoricCaseInstanceQuery`	`caseInstanceBusinessKeyLike(String caseInstanceBusinessKeyLike)` Only select historic case instances which had a business key like the given value.
`HistoricCaseInstanceQuery`	`caseInstanceId(String caseInstanceId)` Only select historic case instances with the given case instance id.
`HistoricCaseInstanceQuery`	`caseInstanceIds(Set<String> caseInstanceIds)` Only select historic case instances whose id is in the given set of ids.
`HistoricCaseInstanceQuery`	`closed()` Only select historic case instances which are closed
`HistoricCaseInstanceQuery`	`closedAfter(Date date)` Only select historic case instances that were closed after the given date.
`HistoricCaseInstanceQuery`	`closedBefore(Date date)` Only select historic case instances that were closed before the given date.
`HistoricCaseInstanceQuery`	`completed()` Only select historic case instances which are completed
`HistoricCaseInstanceQuery`	`createdAfter(Date date)` Only select historic case instances that were created after the given date.
`HistoricCaseInstanceQuery`	`createdBefore(Date date)` Only select historic case instances that were created before the given date.
`HistoricCaseInstanceQuery`	`createdBy(String userId)` Only select historic case instance that are created by the given user.
`HistoricCaseInstanceQuery`	`notClosed()` Only select historic case instance that are not yet closed.
`HistoricCaseInstanceQuery`	`orderByCaseDefinitionId()` Order by the case definition id (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricCaseInstanceQuery`	`orderByCaseInstanceBusinessKey()` Order by the business key (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricCaseInstanceQuery`	`orderByCaseInstanceCloseTime()` Order by the close time (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricCaseInstanceQuery`	`orderByCaseInstanceCreateTime()` Order by the create time (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricCaseInstanceQuery`	`orderByCaseInstanceDuration()` Order by the duration of the case instance (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricCaseInstanceQuery`	`orderByCaseInstanceId()` Order by the case instance id (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricCaseInstanceQuery`	`orderByTenantId()` Order by tenant id (needs to be followed by `Query.asc()` or `Query.desc()`).
`HistoricCaseInstanceQuery`	`subCaseInstanceId(String subCaseInstanceId)` Only select historic case instances having a sub case instance with the given case instance id.
`HistoricCaseInstanceQuery`	`subProcessInstanceId(String subProcessInstanceId)` Only select historic case instances having a sub process instance with the given process instance id.
`HistoricCaseInstanceQuery`	`superCaseInstanceId(String superCaseInstanceId)` Only select historic case instances started by the given case instance.
`HistoricCaseInstanceQuery`	`superProcessInstanceId(String superProcessInstanceId)` Only select historic case instances started by the given process instance.
`HistoricCaseInstanceQuery`	`tenantIdIn(String... tenantIds)` Only select historic case instances with one of the given tenant ids.
`HistoricCaseInstanceQuery`	`terminated()` Only select historic case instances which are terminated
`HistoricCaseInstanceQuery`	`variableValueEquals(String name, Object value)` Only select case instances which have a global variable with the given value.
`HistoricCaseInstanceQuery`	`variableValueGreaterThan(String name, Object value)` Only select case instances which had a global variable with the given name and a value greater than the given value when they where closed.
`HistoricCaseInstanceQuery`	`variableValueGreaterThanOrEqual(String name, Object value)` Only select case instances which have a global variable with the given name and a value greater or equal than the given value.
`HistoricCaseInstanceQuery`	`variableValueLessThan(String name, Object value)` Only select case instances which have a global variable with the given name and a value less than the given value.
`HistoricCaseInstanceQuery`	`variableValueLessThanOrEqual(String name, Object value)` Only select case instances which have a global variable with the given name and a value less or equal than the given value.
`HistoricCaseInstanceQuery`	`variableValueLike(String name, String value)` Only select case instances which have a global variable with the given name and a value like given value.
`HistoricCaseInstanceQuery`	`variableValueNotEquals(String name, Object value)` Only select case instances which have a global variable with the given name but a different value.
`HistoricCaseInstanceQuery`	`withoutTenantId()` Only selects historic case instances which have no tenant id.

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

- Method Detail
  - caseInstanceId
```
HistoricCaseInstanceQuery caseInstanceId(String caseInstanceId)
```
    Only select historic case instances with the given case instance id.
  - caseInstanceIds
```
HistoricCaseInstanceQuery caseInstanceIds(Set<String> caseInstanceIds)
```
    Only select historic case instances whose id is in the given set of ids.
  - caseDefinitionId
```
HistoricCaseInstanceQuery caseDefinitionId(String caseDefinitionId)
```
    Only select historic case instances for the given case definition
  - caseDefinitionKey
```
HistoricCaseInstanceQuery caseDefinitionKey(String caseDefinitionKey)
```
    Only select historic case instances that are defined by a case definition with the given key.
  - caseDefinitionKeyNotIn
```
HistoricCaseInstanceQuery caseDefinitionKeyNotIn(List<String> caseDefinitionKeys)
```
    Only select historic case instances that don't have a case definition of which the key is present in the given list
  - caseDefinitionName
```
HistoricCaseInstanceQuery caseDefinitionName(String caseDefinitionName)
```
    Only select historic case instances that are defined by a case definition with the given name.
  - caseDefinitionNameLike
```
HistoricCaseInstanceQuery caseDefinitionNameLike(String nameLike)
```
    Only select historic case instances that are defined by case 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%).
  - caseInstanceBusinessKey
```
HistoricCaseInstanceQuery caseInstanceBusinessKey(String caseInstanceBusinessKey)
```
    Only select historic case instances with the given business key
  - caseInstanceBusinessKeyLike
```
HistoricCaseInstanceQuery caseInstanceBusinessKeyLike(String caseInstanceBusinessKeyLike)
```
    Only select historic case instances which had a business key like the given value.
    
    Parameters:
    caseInstanceBusinessKeyLike - The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
  - caseActivityIdIn
```
HistoricCaseInstanceQuery caseActivityIdIn(String... caseActivityIds)
```
    Only selects historic case instances with historic case activity instances in at least one of the given case activity ids.
  - createdBefore
```
HistoricCaseInstanceQuery createdBefore(Date date)
```
    Only select historic case instances that were created before the given date.
  - createdAfter
```
HistoricCaseInstanceQuery createdAfter(Date date)
```
    Only select historic case instances that were created after the given date.
  - closedBefore
```
HistoricCaseInstanceQuery closedBefore(Date date)
```
    Only select historic case instances that were closed before the given date.
  - closedAfter
```
HistoricCaseInstanceQuery closedAfter(Date date)
```
    Only select historic case instances that were closed after the given date.
  - createdBy
```
HistoricCaseInstanceQuery createdBy(String userId)
```
    Only select historic case instance that are created by the given user.
  - superCaseInstanceId
```
HistoricCaseInstanceQuery superCaseInstanceId(String superCaseInstanceId)
```
    Only select historic case instances started by the given case instance.
  - subCaseInstanceId
```
HistoricCaseInstanceQuery subCaseInstanceId(String subCaseInstanceId)
```
    Only select historic case instances having a sub case instance with the given case instance id. Note that there will always be maximum only one such case instance that can be the result of this query.
  - superProcessInstanceId
```
HistoricCaseInstanceQuery superProcessInstanceId(String superProcessInstanceId)
```
    Only select historic case instances started by the given process instance.
  - subProcessInstanceId
```
HistoricCaseInstanceQuery subProcessInstanceId(String subProcessInstanceId)
```
    Only select historic case instances having a sub process instance with the given process instance id. Note that there will always be maximum only one such case instance that can be the result of this query.
  - tenantIdIn
```
HistoricCaseInstanceQuery tenantIdIn(String... tenantIds)
```
    Only select historic case instances with one of the given tenant ids.
  - withoutTenantId
```
HistoricCaseInstanceQuery withoutTenantId()
```
    Only selects historic case instances which have no tenant id.
  - active
```
HistoricCaseInstanceQuery active()
```
    Only select historic case instances which are active
  - completed
```
HistoricCaseInstanceQuery completed()
```
    Only select historic case instances which are completed
  - terminated
```
HistoricCaseInstanceQuery terminated()
```
    Only select historic case instances which are terminated
  - closed
```
HistoricCaseInstanceQuery closed()
```
    Only select historic case instances which are closed
  - notClosed
```
HistoricCaseInstanceQuery notClosed()
```
    Only select historic case instance that are not yet closed.
  - variableValueEquals
```
HistoricCaseInstanceQuery variableValueEquals(String name,
                                            Object value)
```
    Only select case instances which have a global variable with the given value.
    
    Parameters:
    name - the name of the variable
    value - the value of the variable
    
    Throws:
    
    NotValidException - if the name is null
  - variableValueNotEquals
```
HistoricCaseInstanceQuery variableValueNotEquals(String name,
                                               Object value)
```
    Only select case instances which have a global variable with the given name but a different value.
    
    Parameters:
    name - the name of the variable
    value - the value of the variable
    
    Throws:
    
    NotValidException - if the name is null
  - variableValueGreaterThan
```
HistoricCaseInstanceQuery variableValueGreaterThan(String name,
                                                 Object value)
```
    Only select case instances which had a global variable with the given name and a value greater than the given value when they where closed.
    
    Parameters:
    name - the name of the variable
    value - the value of the variable
    
    Throws:
    
    NotValidException - if the name or value is null
  - variableValueGreaterThanOrEqual
```
HistoricCaseInstanceQuery variableValueGreaterThanOrEqual(String name,
                                                        Object value)
```
    Only select case instances which have a global variable with the given name and a value greater or equal than the given value.
    
    Parameters:
    name - the name of the variable
    value - the value of the variable
    
    Throws:
    
    NotValidException - if the name or value is null
  - variableValueLessThan
```
HistoricCaseInstanceQuery variableValueLessThan(String name,
                                              Object value)
```
    Only select case instances which have a global variable with the given name and a value less than the given value.
    
    Parameters:
    name - the name of the variable
    value - the value of the variable
    
    Throws:
    
    NotValidException - if the name or value is null
  - variableValueLessThanOrEqual
```
HistoricCaseInstanceQuery variableValueLessThanOrEqual(String name,
                                                     Object value)
```
    Only select case instances which have a global variable with the given name and a value less or equal than the given value.
    
    Parameters:
    name - the name of the variable
    value - the value of the variable
    
    Throws:
    
    NotValidException - if the name or value is null
  - variableValueLike
```
HistoricCaseInstanceQuery variableValueLike(String name,
                                          String value)
```
    Only select case instances which have a global variable with the given name and a value like given value.
    
    Parameters:
    name - the name of the variable
    value - the value of the variable, it can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string), contains (%string%)
    
    Throws:
    
    NotValidException - if the name or value is null
  - orderByCaseInstanceId
```
HistoricCaseInstanceQuery orderByCaseInstanceId()
```
    Order by the case instance id (needs to be followed by Query.asc() or Query.desc()).
  - orderByCaseDefinitionId
```
HistoricCaseInstanceQuery orderByCaseDefinitionId()
```
    Order by the case definition id (needs to be followed by Query.asc() or Query.desc()).
  - orderByCaseInstanceBusinessKey
```
HistoricCaseInstanceQuery orderByCaseInstanceBusinessKey()
```
    Order by the business key (needs to be followed by Query.asc() or Query.desc()).
  - orderByCaseInstanceCreateTime
```
HistoricCaseInstanceQuery orderByCaseInstanceCreateTime()
```
    Order by the create time (needs to be followed by Query.asc() or Query.desc()).
  - orderByCaseInstanceCloseTime
```
HistoricCaseInstanceQuery orderByCaseInstanceCloseTime()
```
    Order by the close time (needs to be followed by Query.asc() or Query.desc()).
  - orderByCaseInstanceDuration
```
HistoricCaseInstanceQuery orderByCaseInstanceDuration()
```
    Order by the duration of the case instance (needs to be followed by Query.asc() or Query.desc()).
  - orderByTenantId
```
HistoricCaseInstanceQuery orderByTenantId()
```
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of historic case instances without tenant id is database-specific.

Interface HistoricCaseInstanceQuery

Method Summary

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

Method Detail

caseInstanceId

caseInstanceIds

caseDefinitionId

caseDefinitionKey

caseDefinitionKeyNotIn

caseDefinitionName

caseDefinitionNameLike

caseInstanceBusinessKey

caseInstanceBusinessKeyLike

caseActivityIdIn

createdBefore

createdAfter

closedBefore

closedAfter

createdBy

superCaseInstanceId

subCaseInstanceId

superProcessInstanceId

subProcessInstanceId

tenantIdIn

withoutTenantId

active

completed

terminated

closed

notClosed

variableValueEquals

variableValueNotEquals

variableValueGreaterThan

variableValueGreaterThanOrEqual

variableValueLessThan

variableValueLessThanOrEqual

variableValueLike

orderByCaseInstanceId

orderByCaseDefinitionId

orderByCaseInstanceBusinessKey

orderByCaseInstanceCreateTime

orderByCaseInstanceCloseTime

orderByCaseInstanceDuration

orderByTenantId