Uses of Interface
org.flowable.engine.history.HistoricProcessInstanceQuery
Packages that use HistoricProcessInstanceQuery
Package
Description
Public API of the Flowable engine.
Typical usage of the API starts by the creation of a
Through the services obtained from such a
Typical usage of the API starts by the creation of a
ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine can be obtained.Through the services obtained from such a
ProcessEngine, BPM and workflow operation
can be executed:RepositoryService: Manages Deployments.RuntimeService: For starting and searching ProcessInstances.TaskService: Exposes operations to manage human (standalone) tasks, such as claiming, completing and assigning tasks.IdentityService: Used for managing users, groups and the relations between them.ManagementService: Exposes engine administration and maintenance operations,
which have no relation to the runtime exection of business processes.HistoryService: Exposes information about ongoing and past process instances.FormService: Access to form data and rendered forms for starting new process instances and completing tasks.Classes related to the
HistoryService.API implementation classes, which shouldn't directly be used by end-users.
-
Uses of HistoricProcessInstanceQuery in org.flowable.engine
Methods in org.flowable.engine that return HistoricProcessInstanceQueryModifier and TypeMethodDescriptionDefaultHistoryCleaningManager.createHistoricProcessInstanceCleaningQuery()HistoryCleaningManager.createHistoricProcessInstanceCleaningQuery()HistoryService.createHistoricProcessInstanceQuery()Creates a new programmatic query to search forHistoricProcessInstances. -
Uses of HistoricProcessInstanceQuery in org.flowable.engine.history
Methods in org.flowable.engine.history that return HistoricProcessInstanceQueryModifier and TypeMethodDescriptionHistoricProcessInstanceQuery.activeActivityId(String activityId) Select the historic process instances which have an active activity instance like the provided id.HistoricProcessInstanceQuery.activeActivityIds(Set<String> activityIds) Select the historic process instances which have an active activity instance like the provided ids.HistoricProcessInstanceQuery.deleted()Only select historic process instances that are deleted.HistoricProcessInstanceQuery.deploymentId(String deploymentId) Only select historic process instances that are defined by a process definition with the given deployment identifier.HistoricProcessInstanceQuery.deploymentIdIn(List<String> deploymentIds) Only select historic process instances that are defined by a process definition with one of the given deployment identifiers.HistoricProcessInstanceQuery.endOr()End an OR statement.HistoricProcessInstanceQuery.excludeSubprocesses(boolean excludeSubprocesses) Exclude sub processes from the query result;HistoricProcessInstanceQuery.finished()Only select historic process instances that are completely finished.HistoricProcessInstanceQuery.finishedAfter(Date date) Only select historic process instances that were finished after the given date.HistoricProcessInstanceQuery.finishedBefore(Date date) Only select historic process instances that were finished before the given date.HistoricProcessInstanceQuery.includeProcessVariables()Include process variables in the process query resultHistoricProcessInstanceQuery.involvedGroup(String groupId, String identityLinkType) Only select the historic process instances with which the group with the given id and link type is involved.HistoricProcessInstanceQuery.involvedGroups(Set<String> groups) Only select the historic process instances with which the group with the given ids are involved.HistoricProcessInstanceQuery.involvedUser(String userId) Only select the historic process instances with which the user with the given id is involved.HistoricProcessInstanceQuery.involvedUser(String userId, String identityLinkType) Only select the historic process instances with which the user with the given id and link type is involved.HistoricProcessInstanceQuery.limitProcessInstanceVariables(Integer processInstanceVariablesLimit) Deprecated.no longer needed, this is a noopLocalize historic process name and description to specified locale.HistoricProcessInstanceQuery.localVariableExists(String name) Only select process instances which have a local variable with the given name.HistoricProcessInstanceQuery.localVariableNotExists(String name) Only select process instances which does not have a local variable with the given name.HistoricProcessInstanceQuery.localVariableValueEquals(Object value) Only select process instances which had at least one local variable with the given value when they ended.HistoricProcessInstanceQuery.localVariableValueEquals(String name, Object value) Only select process instances which had a local variable with the given value when they ended.HistoricProcessInstanceQuery.localVariableValueEqualsIgnoreCase(String name, String value) Only select historic process instances which have a local string variable with the given value, case insensitive.HistoricProcessInstanceQuery.localVariableValueGreaterThan(String name, Object value) Only select process instances which had a local variable value greater than the passed value when they ended.HistoricProcessInstanceQuery.localVariableValueGreaterThanOrEqual(String name, Object value) Only select process instances which had a local variable value greater than or equal to the passed value when they ended.HistoricProcessInstanceQuery.localVariableValueLessThan(String name, Object value) Only select process instances which had a local variable value less than the passed value when the ended.HistoricProcessInstanceQuery.localVariableValueLessThanOrEqual(String name, Object value) Only select process instances which has a local variable value less than or equal to the passed value when they ended.HistoricProcessInstanceQuery.localVariableValueLike(String name, String value) Only select process instances which had a local variable value like the given value when they ended.HistoricProcessInstanceQuery.localVariableValueLikeIgnoreCase(String name, String value) Only select process instances which had a local variable value like (case insensitive) the given value when they ended.HistoricProcessInstanceQuery.localVariableValueNotEquals(String name, Object value) Only select process instances which had a local variable with the given name, but with a different value than the passed value when they ended.HistoricProcessInstanceQuery.localVariableValueNotEqualsIgnoreCase(String name, String value) Only select historic process instances which have a local string variable not matching the given value, case insensitive.HistoricProcessInstanceQuery.notDeleted()Only select historic process instance that are not deleted.HistoricProcessInstanceQuery.or()Begin an OR statement.HistoricProcessInstanceQuery.orderByProcessDefinitionId()Order by the process definition id (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQuery.orderByProcessInstanceBusinessKey()Order by the business key (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQuery.orderByProcessInstanceDuration()Order by the duration of the process instance (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQuery.orderByProcessInstanceEndTime()Order by the end time (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQuery.orderByProcessInstanceId()Order by the process instance id (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQuery.orderByProcessInstanceStartTime()Order by the start time (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQuery.orderByTenantId()Order by tenant id (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQuery.processDefinitionCategory(String processDefinitionCategory) Only select historic process instances whose process definition category is processDefinitionCategory.HistoricProcessInstanceQuery.processDefinitionId(String processDefinitionId) Only select historic process instances for the given process definitionHistoricProcessInstanceQuery.processDefinitionKey(String processDefinitionKey) Only select historic process instances that are defined by a process definition with the given key.HistoricProcessInstanceQuery.processDefinitionKeyIn(List<String> processDefinitionKeys) Only select historic process instances that are defined by a process definition with one of the given process definition keys.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 listHistoricProcessInstanceQuery.processDefinitionName(String processDefinitionName) Select process historic instances whose process definition name is processDefinitionNameHistoricProcessInstanceQuery.processDefinitionVersion(Integer processDefinitionVersion) Only select historic process instances with a certain process definition version.HistoricProcessInstanceQuery.processInstanceBusinessKey(String processInstanceBusinessKey) Only select historic process instances with the given business keyHistoricProcessInstanceQuery.processInstanceBusinessKeyLike(String businessKeyLike) Only select historic process instances with a business key like the given value.HistoricProcessInstanceQuery.processInstanceBusinessStatus(String businessStatus) Only select historic process instances with the given business statusHistoricProcessInstanceQuery.processInstanceBusinessStatusLike(String businessStatusLike) Only select historic process instances with a business status like the given value.HistoricProcessInstanceQuery.processInstanceCallbackId(String callbackId) Only select process instances with the given callback identifier.HistoricProcessInstanceQuery.processInstanceCallbackType(String callbackType) Only select process instances with the given callback type.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.processInstanceName(String name) Only select process instances with the given name.HistoricProcessInstanceQuery.processInstanceNameLike(String nameLike) Only select process instances with a name like the given value.HistoricProcessInstanceQuery.processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase) Only select process instances with a name like the given value, ignoring upper/lower case.HistoricProcessInstanceQuery.processInstanceReferenceId(String referenceId) Only select process instances with the given reference identifier.HistoricProcessInstanceQuery.processInstanceReferenceType(String referenceType) Only select process instances with the given reference type.HistoricProcessInstanceQuery.processInstanceTenantId(String tenantId) Only select process instances that have the given tenant id.HistoricProcessInstanceQuery.processInstanceTenantIdLike(String tenantIdLike) Only select process instances with a tenant id like the given one.HistoricProcessInstanceQuery.processInstanceWithoutTenantId()Only select process instances that do not have a tenant id.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.Only select historic process instance that are started by the given user.HistoricProcessInstanceQuery.superProcessInstanceId(String superProcessInstanceId) Only select historic process instances started by the given process instance.HistoricProcessInstanceQuery.unfinished()Only select historic process instance that are not yet finished.HistoricProcessInstanceQuery.variableExists(String name) Only select process instances which have a global variable with the given name.HistoricProcessInstanceQuery.variableNotExists(String name) Only select process instances which does not have a global variable with the given name.HistoricProcessInstanceQuery.variableValueEquals(Object value) Only select process instances which had at least one global variable with the given value when they ended.HistoricProcessInstanceQuery.variableValueEquals(String name, Object value) Only select process instances which had a global variable with the given value when they ended.HistoricProcessInstanceQuery.variableValueEqualsIgnoreCase(String name, String value) Only select historic process instances which have a global string variable with the given value, case insensitive.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 a global variable value like the given value when they ended.HistoricProcessInstanceQuery.variableValueLikeIgnoreCase(String name, String value) Only select process instances which had a global variable value like (case insensitive) 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.variableValueNotEqualsIgnoreCase(String name, String value) Only select historic process instances which have a global string variable not matching the given value, case insensitive.HistoricProcessInstanceQuery.withJobException()Only select process instances that failed due to an exception happening during a job execution.HistoricProcessInstanceQuery.withLocalizationFallback()Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.HistoricProcessInstanceQuery.withoutProcessInstanceCallbackId()Only select process instances that do not have a callback identifier. -
Uses of HistoricProcessInstanceQuery in org.flowable.engine.impl
Classes in org.flowable.engine.impl that implement HistoricProcessInstanceQueryMethods in org.flowable.engine.impl that return HistoricProcessInstanceQueryModifier and TypeMethodDescriptionHistoricProcessInstanceQueryImpl.activeActivityId(String activityId) HistoricProcessInstanceQueryImpl.activeActivityIds(Set<String> activityIds) HistoryServiceImpl.createHistoricProcessInstanceQuery()HistoricProcessInstanceQueryImpl.deleted()HistoricProcessInstanceQueryImpl.deploymentId(String deploymentId) HistoricProcessInstanceQueryImpl.deploymentIdIn(List<String> deploymentIds) HistoricProcessInstanceQueryImpl.endOr()HistoricProcessInstanceQueryImpl.excludeSubprocesses(boolean excludeSubprocesses) HistoricProcessInstanceQueryImpl.finished()HistoricProcessInstanceQueryImpl.finishedAfter(Date finishedAfter) HistoricProcessInstanceQueryImpl.finishedBefore(Date finishedBefore) HistoricProcessInstanceQueryImpl.includeProcessVariables()HistoricProcessInstanceQueryImpl.involvedGroup(String groupId, String identityLinkType) HistoricProcessInstanceQueryImpl.involvedGroups(Set<String> involvedGroups) HistoricProcessInstanceQueryImpl.involvedUser(String involvedUser) HistoricProcessInstanceQueryImpl.involvedUser(String userId, String identityLinkType) HistoricProcessInstanceQueryImpl.limitProcessInstanceVariables(Integer processInstanceVariablesLimit) HistoricProcessInstanceQueryImpl.localVariableExists(String name) HistoricProcessInstanceQueryImpl.localVariableNotExists(String name) HistoricProcessInstanceQueryImpl.localVariableValueEquals(Object variableValue) HistoricProcessInstanceQueryImpl.localVariableValueEquals(String variableName, Object variableValue) HistoricProcessInstanceQueryImpl.localVariableValueEqualsIgnoreCase(String name, String value) HistoricProcessInstanceQueryImpl.localVariableValueGreaterThan(String name, Object value) HistoricProcessInstanceQueryImpl.localVariableValueGreaterThanOrEqual(String name, Object value) HistoricProcessInstanceQueryImpl.localVariableValueLessThan(String name, Object value) HistoricProcessInstanceQueryImpl.localVariableValueLessThanOrEqual(String name, Object value) HistoricProcessInstanceQueryImpl.localVariableValueLike(String name, String value) HistoricProcessInstanceQueryImpl.localVariableValueLikeIgnoreCase(String name, String value) HistoricProcessInstanceQueryImpl.localVariableValueNotEquals(String variableName, Object variableValue) HistoricProcessInstanceQueryImpl.localVariableValueNotEqualsIgnoreCase(String name, String value) HistoricProcessInstanceQueryImpl.notDeleted()HistoricProcessInstanceQueryImpl.or()HistoricProcessInstanceQueryImpl.orderByProcessDefinitionId()HistoricProcessInstanceQueryImpl.orderByProcessInstanceBusinessKey()HistoricProcessInstanceQueryImpl.orderByProcessInstanceDuration()HistoricProcessInstanceQueryImpl.orderByProcessInstanceEndTime()HistoricProcessInstanceQueryImpl.orderByProcessInstanceId()HistoricProcessInstanceQueryImpl.orderByProcessInstanceStartTime()HistoricProcessInstanceQueryImpl.orderByTenantId()HistoricProcessInstanceQueryImpl.processDefinitionCategory(String processDefinitionCategory) HistoricProcessInstanceQueryImpl.processDefinitionKey(String processDefinitionKey) HistoricProcessInstanceQueryImpl.processDefinitionKeyIn(List<String> processDefinitionKeys) HistoricProcessInstanceQueryImpl.processDefinitionKeyNotIn(List<String> processDefinitionKeys) HistoricProcessInstanceQueryImpl.processDefinitionName(String processDefinitionName) HistoricProcessInstanceQueryImpl.processDefinitionVersion(Integer processDefinitionVersion) HistoricProcessInstanceQueryImpl.processInstanceBusinessKey(String businessKey) HistoricProcessInstanceQueryImpl.processInstanceBusinessKeyLike(String businessKeyLike) HistoricProcessInstanceQueryImpl.processInstanceBusinessStatus(String businessStatus) HistoricProcessInstanceQueryImpl.processInstanceBusinessStatusLike(String businessStatusLike) HistoricProcessInstanceQueryImpl.processInstanceCallbackId(String callbackId) HistoricProcessInstanceQueryImpl.processInstanceCallbackType(String callbackType) HistoricProcessInstanceQueryImpl.processInstanceIds(Set<String> processInstanceIds) HistoricProcessInstanceQueryImpl.processInstanceName(String name) HistoricProcessInstanceQueryImpl.processInstanceNameLike(String nameLike) HistoricProcessInstanceQueryImpl.processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase) HistoricProcessInstanceQueryImpl.processInstanceReferenceId(String referenceId) HistoricProcessInstanceQueryImpl.processInstanceReferenceType(String referenceType) HistoricProcessInstanceQueryImpl.processInstanceTenantId(String tenantId) HistoricProcessInstanceQueryImpl.processInstanceTenantIdLike(String tenantIdLike) HistoricProcessInstanceQueryImpl.processInstanceWithoutTenantId()HistoricProcessInstanceQueryImpl.startedAfter(Date startedAfter) HistoricProcessInstanceQueryImpl.startedBefore(Date startedBefore) HistoricProcessInstanceQueryImpl.superProcessInstanceId(String superProcessInstanceId) HistoricProcessInstanceQueryImpl.unfinished()HistoricProcessInstanceQueryImpl.variableExists(String name) HistoricProcessInstanceQueryImpl.variableNotExists(String name) HistoricProcessInstanceQueryImpl.variableValueEquals(Object variableValue) HistoricProcessInstanceQueryImpl.variableValueEquals(String variableName, Object variableValue) HistoricProcessInstanceQueryImpl.variableValueEqualsIgnoreCase(String name, String value) HistoricProcessInstanceQueryImpl.variableValueGreaterThan(String name, Object value) HistoricProcessInstanceQueryImpl.variableValueGreaterThanOrEqual(String name, Object value) HistoricProcessInstanceQueryImpl.variableValueLessThan(String name, Object value) HistoricProcessInstanceQueryImpl.variableValueLessThanOrEqual(String name, Object value) HistoricProcessInstanceQueryImpl.variableValueLike(String name, String value) HistoricProcessInstanceQueryImpl.variableValueLikeIgnoreCase(String name, String value) HistoricProcessInstanceQueryImpl.variableValueNotEquals(String variableName, Object variableValue) HistoricProcessInstanceQueryImpl.variableValueNotEqualsIgnoreCase(String name, String value) HistoricProcessInstanceQueryImpl.withJobException()HistoricProcessInstanceQueryImpl.withLocalizationFallback()HistoricProcessInstanceQueryImpl.withoutProcessInstanceCallbackId() -
Uses of HistoricProcessInstanceQuery in org.flowable.engine.impl.delete
Fields in org.flowable.engine.impl.delete declared as HistoricProcessInstanceQueryModifier and TypeFieldDescriptionprotected HistoricProcessInstanceQueryBatchDeleteProcessConfig.queryMethods in org.flowable.engine.impl.delete that return HistoricProcessInstanceQueryModifier and TypeMethodDescriptionprotected static HistoricProcessInstanceQueryBatchDeleteProcessConfig.createQuery(com.fasterxml.jackson.databind.JsonNode queryNode, ProcessEngineConfigurationImpl engineConfiguration) BatchDeleteProcessConfig.getQuery()Methods in org.flowable.engine.impl.delete with parameters of type HistoricProcessInstanceQueryModifier and TypeMethodDescriptionprotected static voidBatchDeleteProcessConfig.populateOrQueryObjects(com.fasterxml.jackson.databind.JsonNode orQueryObjectsNode, HistoricProcessInstanceQuery query, ProcessEngineConfigurationImpl engineConfiguration) protected static voidBatchDeleteProcessConfig.populateQuery(com.fasterxml.jackson.databind.JsonNode queryNode, HistoricProcessInstanceQuery query, ProcessEngineConfigurationImpl engineConfiguration) protected static voidBatchDeleteProcessConfig.populateQueryVariableValues(com.fasterxml.jackson.databind.JsonNode variableValuesNode, HistoricProcessInstanceQuery query, ProcessEngineConfigurationImpl engineConfiguration) -
Uses of HistoricProcessInstanceQuery in org.flowable.engine.interceptor
Methods in org.flowable.engine.interceptor with parameters of type HistoricProcessInstanceQueryModifier and TypeMethodDescriptionvoidHistoricProcessInstanceQueryInterceptor.afterHistoricProcessInstanceQueryExecute(HistoricProcessInstanceQuery processInstanceQuery, List<HistoricProcessInstance> processInstances) voidHistoricProcessInstanceQueryInterceptor.beforeHistoricProcessInstanceQueryExecute(HistoricProcessInstanceQuery processInstanceQuery)