# Uses of Interface
org.flowable.cmmn.api.history.HistoricCaseInstanceQuery

Packages that use HistoricCaseInstanceQuery
Package
Description
org.flowable.cmmn.api
org.flowable.cmmn.api.history

- ## Uses of HistoricCaseInstanceQuery in org.flowable.cmmn.api

  Methods in org.flowable.cmmn.api that return HistoricCaseInstanceQuery
  Modifier and Type
  Method
  Description
  `HistoricCaseInstanceQuery`
  CmmnHistoryCleaningManager.`createHistoricCaseInstanceCleaningQuery()`
  `HistoricCaseInstanceQuery`
  CmmnHistoryService.`createHistoricCaseInstanceQuery()`

- ## Uses of HistoricCaseInstanceQuery in org.flowable.cmmn.api.history

  Methods in org.flowable.cmmn.api.history that return HistoricCaseInstanceQuery
  Modifier and Type
  Method
  Description
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`activePlanItemDefinitionId(String planItemDefinitionId)`
  Select the historic case instances with an active plan item definition id equal to the provided definition id.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`activePlanItemDefinitionIds(Set<String> planItemDefinitionIds)`
  Select the historic case instances with an active plan item definition id equal to one of the provided definition ids.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionCategory(String caseDefinitionCategory)`
  Only select historic case instances with the given case definition category.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionCategoryLike(String caseDefinitionCategoryLike)`
  Only select historic case instances with a case definition category like the given value.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionCategoryLikeIgnoreCase(String caseDefinitionCategoryLikeIgnoreCase)`
  Only select historic case instances with a case definition category like the given value, ignoring upper/lower case.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionId(String caseDefinitionId)`
  Only select historic case instances with the given case definition identifier.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionIds(Set<String> caseDefinitionIds)`
  Only select historic case instances with the given case definition ids.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionKey(String caseDefinitionKey)`
  Only select historic case instances with the given key.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionKeyLike(String caseDefinitionKeyLike)`
  Only select historic case instances with a definition key like the given value.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionKeyLikeIgnoreCase(String caseDefinitionKeyLikeIgnoreCase)`
  Only select historic case instances with a definition key like the given value, ignoring upper/lower case.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionKeys(Set<String> caseDefinitionKeys)`
  Only select historic case instances with the given keys.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionName(String caseDefinitionName)`
  Only select historic case instances with the given case definition name.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionNameLike(String caseDefinitionNameLike)`
  Only select historic case instances with a case definition name like the given value.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionNameLikeIgnoreCase(String caseDefinitionNameLikeIgnoreCase)`
  Only select historic case instances with a case definition name like the given value, ignoring upper/lower case.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseDefinitionVersion(Integer caseDefinitionVersion)`
  Only select historic case instances with the given case definition version.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceBusinessKey(String caseInstanceBusinessKey)`
  Only select historic case instances with the given business key.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceBusinessKeyLike(String caseInstanceBusinessKeyLike)`
  Only select historic case instances with a business key like the given value.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceBusinessKeyLikeIgnoreCase(String caseInstanceBusinessKeyLikeIgnoreCase)`
  Only select historic case instances with a business key like the given value, ignoring upper/lower case.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceBusinessStatus(String caseInstanceBusinessStatus)`
  Only select historic case instances with the given business status.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceBusinessStatusLike(String caseInstanceBusinessStatusLike)`
  Only select historic case instances with a business status like the given value.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceBusinessStatusLikeIgnoreCase(String caseInstanceBusinessStatusLikeIgnoreCase)`
  Only select historic case instances with a business status like the given value, ignoring upper/lower case.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceCallbackId(String callbackId)`
  Only select historic case instances that have the provided callback identifier.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceCallbackType(String callbackType)`
  Only select historic case instances that have the provided callback type.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceId(String caseInstanceId)`
  Only select historic case instances with the given identifier.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceIds(Set<String> caseInstanceIds)`
  Only select historic case instances with one the given identifiers.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceName(String caseInstanceName)`
  Only select historic case instances with the given name.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceNameLike(String caseInstanceNameLike)`
  Only select historic case instances like the given name.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)`
  Only select case instances that have a name like (case insensitive) the given name.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceParentId(String parentId)`
  Only select historic case instances with the parent identifier.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceParentScopeId(String parentScopeId)`
  Only select historic case instances with the given case instance parent scope id.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceReferenceId(String referenceId)`
  Only select historic case instance that have the provided reference identifier.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceReferenceType(String referenceType)`
  Only select historic case instance that have the provided reference type.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceRootScopeId(String rootScopeId)`
  Only select historic case instances with the given case instance root scope id.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceTenantId(String tenantId)`
  Only select historic case instances that have the tenant identifier.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceTenantIdLike(String tenantIdLike)`
  Only select historic case instances with a tenant identifier like the given value.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceTenantIdLikeIgnoreCase(String tenantIdLikeIgnoreCase)`
  Only select historic case instances with a tenant identifier like the given value, ignoring upper/lower case.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`caseInstanceWithoutTenantId()`
  Only select historic case instances that have no tenant identifier.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`deploymentId(String deploymentId)`
  Only select historic case instances that are defined by a case definition with the given deployment identifier.
  `HistoricCaseInstanceQuery`
  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`
  HistoricCaseInstanceQuery.`endOr()`
  End an OR statement.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`excludeCaseDefinitionKeys(Set<String> caseDefinitionKeys)`
  Only select historic case instances that don't match the given case definition keys.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`finished()`
  Only select historic case instances that are finished.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`finishedAfter(Date afterTime)`
  Only select historic case instances that are finished after the provided date time.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`finishedBefore(Date beforeTime)`
  Only select historic case instances that are finished before the provided date time.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`includeCaseVariables()`
  Include historic case variables in the historic case query result
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`includeCaseVariables(Collection<String> variableNames)`
  Include the historic case variables with the given names into the query result.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`involvedGroup(String groupId, String identityLinkType)`
  Select the historic case instances with which the group with the given id and identity link type are involved.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`involvedGroups(Set<String> groupIds)`
  Select the historic case instances with which the groups with the given ids are involved.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`involvedUser(String userId)`
  Select the historic case instances with which the user with the given id is involved.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`involvedUser(String userId, String identityLinkType)`
  Select the historic case instances with which the user with the given id and identity link type are involved.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`lastReactivatedAfter(Date afterTime)`
  Only select historic case instance that are reactivated after the provided date time.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`lastReactivatedBefore(Date beforeTime)`
  Only select historic case instance that are reactivated before the provided date time.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`lastReactivatedBy(String userId)`
  Only select historic case instances that are reactivated by the provided user identifier.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`locale(String locale)`
  Localize case name to specified locale.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`or()`
  Begin an OR statement.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`orderByCaseDefinitionId()`
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`orderByCaseDefinitionKey()`
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`orderByCaseInstanceId()`
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`orderByCaseInstanceName()`
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`orderByEndTime()`
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`orderByStartTime()`
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`orderByTenantId()`
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`parentCaseInstanceId(String parentCaseInstanceId)`
  Only select historic case instances that have a parent case instance with the provided id.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`returnIdsOnly()`
  Return only the id value of the case instances, to reduce any additional instance data to be returned.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`startedAfter(Date afterTime)`
  Only select historic case instances that are started after the provided date time.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`startedBefore(Date beforeTime)`
  Only select historic case instances that are started before the provided date time.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`startedBy(String userId)`
  Only select historic case instances that are started by the provided user identifier.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`state(String state)`
  Only select historic case instances that have a state that is equal to the provided value.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`unfinished()`
  Only select historic case instances that are not finished.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`variableExists(String name)`
  Only select case instances which have a variable with the given name.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`variableNotExists(String name)`
  Only select case instances which does not have a variable with the given name.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`variableValueEquals(Object value)`
  Only select case instances which had at least one global variable with the given value when they ended.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`variableValueEquals(String name, Object value)`
  Only select case instances which had a global variable with the given value when they ended.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`variableValueEqualsIgnoreCase(String name, String value)`
  Only select historic case instances which have a string variable with the given value, case insensitive.
  `HistoricCaseInstanceQuery`
  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`
  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`
  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`
  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`
  HistoricCaseInstanceQuery.`variableValueLike(String name, String value)`
  Only select case instances which had global variable value like the given value when they ended.
  `HistoricCaseInstanceQuery`
  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`
  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.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`withLocalizationFallback()`
  Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`withoutCaseInstanceCallbackId()`
  Only select historic case instances that do not have a callback identifier.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`withoutCaseInstanceParent()`
  Only select historic case instances without a parent identifier.
  `HistoricCaseInstanceQuery`
  HistoricCaseInstanceQuery.`withoutSorting()`
  Perform the query without applying sorting parameters.