HistoricCaseInstanceQuery (Flowable

All Superinterfaces:

Query<HistoricCaseInstanceQuery,HistoricCaseInstance>
```
public interface HistoricCaseInstanceQuery
extends Query<HistoricCaseInstanceQuery,HistoricCaseInstance>
```
Author:

Joram Barrez, Tijs Rademakers

Nested Class Summary
- Nested classes/interfaces inherited from interface org.flowable.engine.common.api.query.Query
  Query.NullHandlingOnOrder

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`HistoricCaseInstanceQuery`	`caseDefinitionCategory(String caseDefinitionCategory)` Only select historic case instances with the given case definition category.
`HistoricCaseInstanceQuery`	`caseDefinitionId(String caseDefinitionId)` Only select historic case instances with the given case definition identifier.
`HistoricCaseInstanceQuery`	`caseDefinitionKey(String caseDefinitionKey)` Only select historic case instances with the given key.
`HistoricCaseInstanceQuery`	`caseDefinitionKeys(Set<String> caseDefinitionKeys)` Only select historic case instances with the given keys.
`HistoricCaseInstanceQuery`	`caseDefinitionName(String caseDefinitionName)` Only select historic case instances with the given case definition name.
`HistoricCaseInstanceQuery`	`caseDefinitionVersion(Integer caseDefinitionVersion)` Only select historic case instances with the given case definition version.
`HistoricCaseInstanceQuery`	`caseInstanceBusinessKey(String caseInstanceBusinessKey)` Only select historic case instances with the given business key.
`HistoricCaseInstanceQuery`	`caseInstanceCallbackId(String callbackId)` Only select historic case instances that have the provided callback identifier.
`HistoricCaseInstanceQuery`	`caseInstanceCallbackType(String callbackType)` Only select historic case instances that have the provided callback type.
`HistoricCaseInstanceQuery`	`caseInstanceId(String caseInstanceId)` Only select historic case instances with the given identifier.
`HistoricCaseInstanceQuery`	`caseInstanceIds(Set<String> caseInstanceIds)` Only select historic case instances with one the given identifiers.
`HistoricCaseInstanceQuery`	`caseInstanceParentId(String parentId)` Only select historic case instances with the parent identifier.
`HistoricCaseInstanceQuery`	`caseInstanceTenantId(String tenantId)` Only select historic case instances that have the tenant identifier.
`HistoricCaseInstanceQuery`	`caseInstanceWithoutTenantId()` Only select historic case instances that have no tenant identifier.
`HistoricCaseInstanceQuery`	`deploymentId(String deploymentId)` Only select historic case instances that are defined by a case definition with the given deployment identifier.
`HistoricCaseInstanceQuery`	`deploymentIds(List<String> deploymentIds)` Only select historic case instances that are defined by a case definition with one of the given deployment identifiers.
`HistoricCaseInstanceQuery`	`finished()` Only select historic case instances that are finished.
`HistoricCaseInstanceQuery`	`finishedAfter(Date afterTime)` Only select historic case instances that are finished after the provided date time.
`HistoricCaseInstanceQuery`	`finishedBefore(Date beforeTime)` Only select historic case instances that are finished before the provided date time.
`HistoricCaseInstanceQuery`	`includeCaseVariables()` Include historic case variables in the historic case query result
`HistoricCaseInstanceQuery`	`limitCaseVariables(Integer historicCaseVariablesLimit)` Limit historic case instance variables
`HistoricCaseInstanceQuery`	`orderByCaseDefinitionId()`
`HistoricCaseInstanceQuery`	`orderByCaseDefinitionKey()`
`HistoricCaseInstanceQuery`	`orderByCaseInstanceId()`
`HistoricCaseInstanceQuery`	`orderByEndTime()`
`HistoricCaseInstanceQuery`	`orderByStartTime()`
`HistoricCaseInstanceQuery`	`orderByTenantId()`
`HistoricCaseInstanceQuery`	`startedAfter(Date afterTime)` Only select historic case instances that are started after the provided date time.
`HistoricCaseInstanceQuery`	`startedBefore(Date beforeTime)` Only select historic case instances that are started before the provided date time.
`HistoricCaseInstanceQuery`	`startedBy(String userId)` Only select historic case instances that are started by the provided user identifier.
`HistoricCaseInstanceQuery`	`unfinished()` Only select historic case instances that are not finished.
`HistoricCaseInstanceQuery`	`variableExists(String name)` Only select case instances which have a variable with the given name.
`HistoricCaseInstanceQuery`	`variableNotExists(String name)` Only select case instances which does not have a variable with the given name.
`HistoricCaseInstanceQuery`	`variableValueEquals(Object value)` Only select case instances which had at least one global variable with the given value when they ended.
`HistoricCaseInstanceQuery`	`variableValueEquals(String name, Object value)` Only select case instances which had a global variable with the given value when they ended.
`HistoricCaseInstanceQuery`	`variableValueEqualsIgnoreCase(String name, String value)` Only select historic case instances which have a string variable with the given value, case insensitive.
`HistoricCaseInstanceQuery`	`variableValueGreaterThan(String name, Object value)` Only select case instances which had a global variable value greater than the passed value when they ended.
`HistoricCaseInstanceQuery`	`variableValueGreaterThanOrEqual(String name, Object value)` Only select case instances which had a global variable value greater than or equal to the passed value when they ended.
`HistoricCaseInstanceQuery`	`variableValueLessThan(String name, Object value)` Only select case instances which had a global variable value less than the passed value when the ended.
`HistoricCaseInstanceQuery`	`variableValueLessThanOrEqual(String name, Object value)` Only select case instances which has a global variable value less than or equal to the passed value when they ended.
`HistoricCaseInstanceQuery`	`variableValueLike(String name, String value)` Only select case instances which had global variable value like the given value when they ended.
`HistoricCaseInstanceQuery`	`variableValueLikeIgnoreCase(String name, String value)` Only select case instances which had global variable value like (case insensitive) the given value when they ended.
`HistoricCaseInstanceQuery`	`variableValueNotEquals(String name, Object value)` Only select case instances which had a global variable with the given name, but with a different value than the passed value when they ended.

Methods inherited from interface org.flowable.engine.common.api.query.Query
asc, count, desc, list, listPage, orderBy, orderBy, singleResult

- Method Detail
  - caseInstanceId
```
HistoricCaseInstanceQuery caseInstanceId(String caseInstanceId)
```
    Only select historic case instances with the given identifier.
  - caseInstanceIds
```
HistoricCaseInstanceQuery caseInstanceIds(Set<String> caseInstanceIds)
```
    Only select historic case instances with one the given identifiers.
  - caseInstanceBusinessKey
```
HistoricCaseInstanceQuery caseInstanceBusinessKey(String caseInstanceBusinessKey)
```
    Only select historic case instances with the given business key.
  - caseInstanceParentId
```
HistoricCaseInstanceQuery caseInstanceParentId(String parentId)
```
    Only select historic case instances with the parent identifier.
  - caseDefinitionKey
```
HistoricCaseInstanceQuery caseDefinitionKey(String caseDefinitionKey)
```
    Only select historic case instances with the given key.
  - caseDefinitionKeys
```
HistoricCaseInstanceQuery caseDefinitionKeys(Set<String> caseDefinitionKeys)
```
    Only select historic case instances with the given keys.
  - caseDefinitionId
```
HistoricCaseInstanceQuery caseDefinitionId(String caseDefinitionId)
```
    Only select historic case instances with the given case definition identifier.
  - caseDefinitionCategory
```
HistoricCaseInstanceQuery caseDefinitionCategory(String caseDefinitionCategory)
```
    Only select historic case instances with the given case definition category.
  - caseDefinitionName
```
HistoricCaseInstanceQuery caseDefinitionName(String caseDefinitionName)
```
    Only select historic case instances with the given case definition name.
  - caseDefinitionVersion
```
HistoricCaseInstanceQuery caseDefinitionVersion(Integer caseDefinitionVersion)
```
    Only select historic case instances with the given case definition version.
  - includeCaseVariables
```
HistoricCaseInstanceQuery includeCaseVariables()
```
    Include historic case variables in the historic case query result
  - limitCaseVariables
```
HistoricCaseInstanceQuery limitCaseVariables(Integer historicCaseVariablesLimit)
```
    Limit historic case instance variables
  - deploymentId
```
HistoricCaseInstanceQuery deploymentId(String deploymentId)
```
    Only select historic case instances that are defined by a case definition with the given deployment identifier.
  - deploymentIds
```
HistoricCaseInstanceQuery deploymentIds(List<String> deploymentIds)
```
    Only select historic case instances that are defined by a case definition with one of the given deployment identifiers.
  - finished
```
HistoricCaseInstanceQuery finished()
```
    Only select historic case instances that are finished.
  - unfinished
```
HistoricCaseInstanceQuery unfinished()
```
    Only select historic case instances that are not finished.
  - startedBefore
```
HistoricCaseInstanceQuery startedBefore(Date beforeTime)
```
    Only select historic case instances that are started before the provided date time.
  - startedAfter
```
HistoricCaseInstanceQuery startedAfter(Date afterTime)
```
    Only select historic case instances that are started after the provided date time.
  - finishedBefore
```
HistoricCaseInstanceQuery finishedBefore(Date beforeTime)
```
    Only select historic case instances that are finished before the provided date time.
  - finishedAfter
```
HistoricCaseInstanceQuery finishedAfter(Date afterTime)
```
    Only select historic case instances that are finished after the provided date time.
  - startedBy
```
HistoricCaseInstanceQuery startedBy(String userId)
```
    Only select historic case instances that are started by the provided user identifier.
  - caseInstanceCallbackId
```
HistoricCaseInstanceQuery caseInstanceCallbackId(String callbackId)
```
    Only select historic case instances that have the provided callback identifier.
  - caseInstanceCallbackType
```
HistoricCaseInstanceQuery caseInstanceCallbackType(String callbackType)
```
    Only select historic case instances that have the provided callback type.
  - caseInstanceTenantId
```
HistoricCaseInstanceQuery caseInstanceTenantId(String tenantId)
```
    Only select historic case instances that have the tenant identifier.
  - caseInstanceWithoutTenantId
```
HistoricCaseInstanceQuery caseInstanceWithoutTenantId()
```
    Only select historic case instances that have no tenant identifier.
  - variableValueEquals
```
HistoricCaseInstanceQuery variableValueEquals(String name,
                                              Object value)
```
    Only select case instances which had a global variable with the given value when they ended. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    
    name - of the variable, cannot be null.
  - variableValueEquals
```
HistoricCaseInstanceQuery variableValueEquals(Object value)
```
    Only select case instances which had at least one global variable with the given value when they ended. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
  - variableValueEqualsIgnoreCase
```
HistoricCaseInstanceQuery variableValueEqualsIgnoreCase(String name,
                                                        String value)
```
    Only select historic case instances which have a string variable with the given value, case insensitive.
    
    Parameters:
    
    name - name of the variable, cannot be null.
    
    value - value of the variable, cannot be null.
  - variableValueNotEquals
```
HistoricCaseInstanceQuery variableValueNotEquals(String name,
                                                 Object value)
```
    Only select case instances which had a global variable with the given name, but with a different value than the passed value when they ended. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    
    name - of the variable, cannot be null.
  - variableValueGreaterThan
```
HistoricCaseInstanceQuery variableValueGreaterThan(String name,
                                                   Object value)
```
    Only select case 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.
    
    Parameters:
    
    name - cannot be null.
    
    value - cannot be null.
  - variableValueGreaterThanOrEqual
```
HistoricCaseInstanceQuery variableValueGreaterThanOrEqual(String name,
                                                          Object value)
```
    Only select case 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.
    
    Parameters:
    
    name - cannot be null.
    
    value - cannot be null.
  - variableValueLessThan
```
HistoricCaseInstanceQuery variableValueLessThan(String name,
                                                Object value)
```
    Only select case instances which had a global variable value less than the passed value when the ended. 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
```
HistoricCaseInstanceQuery variableValueLessThanOrEqual(String name,
                                                       Object value)
```
    Only select case instances which has a global variable value less 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.
    
    Parameters:
    
    name - cannot be null.
    
    value - cannot be null.
  - variableValueLike
```
HistoricCaseInstanceQuery variableValueLike(String name,
                                            String value)
```
    Only select case instances which had global variable value like the given value when they ended. 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%).
  - variableValueLikeIgnoreCase
```
HistoricCaseInstanceQuery variableValueLikeIgnoreCase(String name,
                                                      String value)
```
    Only select case instances which had global variable value like (case insensitive) the given value when they ended. 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%).
  - variableExists
```
HistoricCaseInstanceQuery variableExists(String name)
```
    Only select case instances which have a variable with the given name.
    
    Parameters:
    
    name - cannot be null.
  - variableNotExists
```
HistoricCaseInstanceQuery variableNotExists(String name)
```
    Only select case instances which does not have a variable with the given name.
    
    Parameters:
    
    name - cannot be null.
  - orderByCaseInstanceId
```
HistoricCaseInstanceQuery orderByCaseInstanceId()
```
  - orderByCaseDefinitionKey
```
HistoricCaseInstanceQuery orderByCaseDefinitionKey()
```
  - orderByCaseDefinitionId
```
HistoricCaseInstanceQuery orderByCaseDefinitionId()
```
  - orderByStartTime
```
HistoricCaseInstanceQuery orderByStartTime()
```
  - orderByEndTime
```
HistoricCaseInstanceQuery orderByEndTime()
```
  - orderByTenantId
```
HistoricCaseInstanceQuery orderByTenantId()
```

Interface HistoricCaseInstanceQuery

Nested Class Summary

Nested classes/interfaces inherited from interface org.flowable.engine.common.api.query.Query

Method Summary

Methods inherited from interface org.flowable.engine.common.api.query.Query

Method Detail

caseInstanceId

caseInstanceIds

caseInstanceBusinessKey

caseInstanceParentId

caseDefinitionKey

caseDefinitionKeys

caseDefinitionId

caseDefinitionCategory

caseDefinitionName

caseDefinitionVersion

includeCaseVariables

limitCaseVariables

deploymentId

deploymentIds

finished

unfinished

startedBefore

startedAfter

finishedBefore

finishedAfter

startedBy

caseInstanceCallbackId

caseInstanceCallbackType

caseInstanceTenantId

caseInstanceWithoutTenantId

variableValueEquals

variableValueEquals

variableValueEqualsIgnoreCase

variableValueNotEquals

variableValueGreaterThan

variableValueGreaterThanOrEqual

variableValueLessThan

variableValueLessThanOrEqual

variableValueLike

variableValueLikeIgnoreCase

variableExists

variableNotExists

orderByCaseInstanceId

orderByCaseDefinitionKey

orderByCaseDefinitionId

orderByStartTime

orderByEndTime

orderByTenantId