Uses of Interface
org.camunda.bpm.engine.history.HistoricProcessInstanceQuery
Package
Description
Public API of the Camunda Platform 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 Deployment
sRuntimeService
:
For starting and searching ProcessInstance
sTaskService
:
Exposes operations to manage human (standalone) Task
s,
such as claiming, completing and assigning tasksIdentityService
:
Used for managing User
s,
Group
s and the relations between themManagementService
:
Exposes engine admin and maintenance operations,
which have no relation to the runtime execution of business processesHistoryService
:
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.
Classes related to the
ManagementService
.Classes related to the
RuntimeService
.-
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine
Modifier and TypeMethodDescriptionHistoryService.createHistoricProcessInstanceQuery()
Creates a new programmatic query to search forHistoricProcessInstance
s.Modifier and TypeMethodDescriptionHistoryService.deleteHistoricProcessInstancesAsync
(List<String> processInstanceIds, HistoricProcessInstanceQuery query, String deleteReason) Deletes historic process instances asynchronously based on query and a list of process instances.HistoryService.deleteHistoricProcessInstancesAsync
(HistoricProcessInstanceQuery query, String deleteReason) Deletes historic process instances asynchronously based on query.RuntimeService.deleteProcessInstancesAsync
(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, String deleteReason, boolean skipCustomListeners, boolean skipSubprocesses) Delete an existing runtime process instances asynchronously using Batch operation.ManagementService.setJobRetriesAsync
(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, int retries) Sets the number of retries that jobs have left asynchronously.RuntimeService.setVariablesAsync
(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, Map<String, ?> variables) Update or create runtime process variables in the root scope of process instances.RuntimeService.setVariablesAsync
(HistoricProcessInstanceQuery historicProcessInstanceQuery, Map<String, ?> variables) Update or create runtime process variables in the root scope of process instances. -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.externaltask
Modifier and TypeMethodDescriptionUpdateExternalTaskRetriesSelectBuilder.historicProcessInstanceQuery
(HistoricProcessInstanceQuery historicProcessInstanceQuery) Selects a list of external tasks with the given historic process instance query. -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.history
Modifier and TypeMethodDescriptionHistoricProcessInstanceQuery.active()
Only select historic process instances that are active.HistoricProcessInstanceQuery.activeActivityIdIn
(String... ids) Only select historic process instances that have active activities with given ids.HistoricProcessInstanceQuery.caseInstanceId
(String caseInstanceId) Only select historic process instances which are associated with the given case instance id.HistoricProcessInstanceQuery.completed()
Only select historic process instances that are completed.HistoricProcessInstanceQuery.endOr()
endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied.HistoricProcessInstanceQuery.executedActivityAfter
(Date date) Only select historic process instances that executed an activity after the given date.HistoricProcessInstanceQuery.executedActivityBefore
(Date date) Only select historic process instances that executed an activity before the given date.HistoricProcessInstanceQuery.executedActivityIdIn
(String... ids) Only select historic process instances that executed activities with given ids.HistoricProcessInstanceQuery.executedJobAfter
(Date date) Only select historic process instances that executed an job after the given date.HistoricProcessInstanceQuery.executedJobBefore
(Date date) Only select historic process instances that executed an job before the given date.HistoricProcessInstanceQuery.externallyTerminated()
Only select historic process instances that are externallyTerminated.HistoricProcessInstanceQuery.finishDateBy
(Date date) Deprecated.HistoricProcessInstanceQuery.finishDateOn
(Date date) Deprecated.usestartedAfter(Date)
andstartedBefore(Date)
insteadHistoricProcessInstanceQuery.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.incidentStatus
(String status) Only select historic process instances with incident status either 'open' or 'resolved'.HistoricProcessInstanceQuery.incidentType
(String incidentType) Only selects process instances with the given incident type.HistoricProcessInstanceQuery.internallyTerminated()
Only select historic process instances that are internallyTerminated.HistoricProcessInstanceQuery.matchVariableNamesIgnoreCase()
The query will match the names of variables in a case-insensitive way.HistoricProcessInstanceQuery.matchVariableValuesIgnoreCase()
The query will match the values of variables in a case-insensitive way.HistoricProcessInstanceQuery.or()
After calling or(), a chain of several filter criteria could follow.HistoricProcessInstanceQuery.orderByProcessDefinitionId()
Order by the process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).HistoricProcessInstanceQuery.orderByProcessDefinitionKey()
Order by the process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).HistoricProcessInstanceQuery.orderByProcessDefinitionName()
Order by the process definition name (needs to be followed byQuery.asc()
orQuery.desc()
).HistoricProcessInstanceQuery.orderByProcessDefinitionVersion()
Order by the process definition version (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.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
(String... processDefinitionKeys) Only select historic process instances that are defined by any given process definition 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 listHistoricProcessInstanceQuery.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 keyHistoricProcessInstanceQuery.processInstanceBusinessKeyIn
(String... processInstanceBusinessKeyIn) Only select historic process instances whose business key is in the given set.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.rootProcessInstances()
Only select historic process instances that are top level process instances.HistoricProcessInstanceQuery.startDateBy
(Date date) Deprecated.usestartedAfter(Date)
andstartedBefore(Date)
insteadHistoricProcessInstanceQuery.startDateOn
(Date date) Deprecated.usestartedAfter(Date)
andstartedBefore(Date)
insteadHistoricProcessInstanceQuery.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.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.suspended()
Only select historic process instances that are suspended.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 incidentsHistoricProcessInstanceQuery.withoutTenantId()
Only selects historic process instances which have no tenant id.HistoricProcessInstanceQuery.withRootIncidents()
Only select historic process instances with root incidentsModifier and TypeMethodDescriptionSetRemovalTimeToHistoricProcessInstancesBuilder.byQuery
(HistoricProcessInstanceQuery historicProcessInstanceQuery) Selects historic process instances by the given query. -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl
Modifier and TypeFieldDescriptionprotected HistoricProcessInstanceQuery
MessageCorrelationAsyncBuilderImpl.historicProcessInstanceQuery
protected HistoricProcessInstanceQuery
SetJobsRetriesByProcessBatchCmd.historicProcessInstanceQuery
protected HistoricProcessInstanceQuery
UpdateProcessInstancesSuspensionStateBuilderImpl.historicProcessInstanceQuery
protected HistoricProcessInstanceQuery
RestartProcessInstanceBuilderImpl.query
Modifier and TypeMethodDescriptionHistoricProcessInstanceQueryImpl.active()
HistoricProcessInstanceQueryImpl.activeActivityIdIn
(String... ids) HistoricProcessInstanceQueryImpl.caseInstanceId
(String caseInstanceId) HistoricProcessInstanceQueryImpl.completed()
HistoryServiceImpl.createHistoricProcessInstanceQuery()
HistoricProcessInstanceQueryImpl.endOr()
HistoricProcessInstanceQueryImpl.executedActivityAfter
(Date date) HistoricProcessInstanceQueryImpl.executedActivityBefore
(Date date) HistoricProcessInstanceQueryImpl.executedActivityIdIn
(String... ids) HistoricProcessInstanceQueryImpl.executedJobAfter
(Date date) HistoricProcessInstanceQueryImpl.executedJobBefore
(Date date) HistoricProcessInstanceQueryImpl.externallyTerminated()
HistoricProcessInstanceQueryImpl.finishDateBy
(Date date) Deprecated.HistoricProcessInstanceQueryImpl.finishDateOn
(Date date) Deprecated.HistoricProcessInstanceQueryImpl.finished()
HistoricProcessInstanceQueryImpl.finishedAfter
(Date date) HistoricProcessInstanceQueryImpl.finishedBefore
(Date date) MessageCorrelationAsyncBuilderImpl.getHistoricProcessInstanceQuery()
RestartProcessInstanceBuilderImpl.getHistoricProcessInstanceQuery()
UpdateProcessInstancesSuspensionStateBuilderImpl.getHistoricProcessInstanceQuery()
HistoricProcessInstanceQueryImpl.incidentMessage
(String incidentMessage) HistoricProcessInstanceQueryImpl.incidentMessageLike
(String incidentMessageLike) HistoricProcessInstanceQueryImpl.incidentStatus
(String status) HistoricProcessInstanceQueryImpl.incidentType
(String incidentType) HistoricProcessInstanceQueryImpl.internallyTerminated()
HistoricProcessInstanceQueryImpl.or()
HistoricProcessInstanceQueryImpl.orderByProcessDefinitionId()
HistoricProcessInstanceQueryImpl.orderByProcessDefinitionKey()
HistoricProcessInstanceQueryImpl.orderByProcessDefinitionName()
HistoricProcessInstanceQueryImpl.orderByProcessDefinitionVersion()
HistoricProcessInstanceQueryImpl.orderByProcessInstanceBusinessKey()
HistoricProcessInstanceQueryImpl.orderByProcessInstanceDuration()
HistoricProcessInstanceQueryImpl.orderByProcessInstanceEndTime()
HistoricProcessInstanceQueryImpl.orderByProcessInstanceId()
HistoricProcessInstanceQueryImpl.orderByProcessInstanceStartTime()
HistoricProcessInstanceQueryImpl.orderByTenantId()
HistoricProcessInstanceQueryImpl.processDefinitionKey
(String processDefinitionKey) HistoricProcessInstanceQueryImpl.processDefinitionKeyIn
(String... processDefinitionKeys) HistoricProcessInstanceQueryImpl.processDefinitionKeyNotIn
(List<String> processDefinitionKeys) HistoricProcessInstanceQueryImpl.processDefinitionName
(String processDefinitionName) HistoricProcessInstanceQueryImpl.processDefinitionNameLike
(String nameLike) HistoricProcessInstanceQueryImpl.processInstanceBusinessKey
(String businessKey) HistoricProcessInstanceQueryImpl.processInstanceBusinessKeyIn
(String... businessKeyIn) HistoricProcessInstanceQueryImpl.processInstanceBusinessKeyLike
(String businessKeyLike) HistoricProcessInstanceQueryImpl.processInstanceIds
(Set<String> processInstanceIds) HistoricProcessInstanceQueryImpl.rootProcessInstances()
HistoricProcessInstanceQueryImpl.startDateBy
(Date date) Deprecated.HistoricProcessInstanceQueryImpl.startDateOn
(Date date) Deprecated.HistoricProcessInstanceQueryImpl.startedAfter
(Date date) HistoricProcessInstanceQueryImpl.startedBefore
(Date date) HistoricProcessInstanceQueryImpl.subCaseInstanceId
(String subCaseInstanceId) HistoricProcessInstanceQueryImpl.subProcessInstanceId
(String subProcessInstanceId) HistoricProcessInstanceQueryImpl.superCaseInstanceId
(String superCaseInstanceId) HistoricProcessInstanceQueryImpl.superProcessInstanceId
(String superProcessInstanceId) HistoricProcessInstanceQueryImpl.suspended()
HistoricProcessInstanceQueryImpl.tenantIdIn
(String... tenantIds) HistoricProcessInstanceQueryImpl.unfinished()
HistoricProcessInstanceQueryImpl.withIncidents()
HistoricProcessInstanceQueryImpl.withoutTenantId()
HistoricProcessInstanceQueryImpl.withRootIncidents()
Modifier and TypeMethodDescriptionUpdateProcessInstancesSuspensionStateBuilderImpl.byHistoricProcessInstanceQuery
(HistoricProcessInstanceQuery historicProcessInstanceQuery) HistoryServiceImpl.deleteHistoricProcessInstancesAsync
(List<String> processInstanceIds, HistoricProcessInstanceQuery query, String deleteReason) HistoryServiceImpl.deleteHistoricProcessInstancesAsync
(HistoricProcessInstanceQuery query, String deleteReason) RuntimeServiceImpl.deleteProcessInstancesAsync
(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, String deleteReason, boolean skipCustomListeners, boolean skipSubprocesses) MessageCorrelationAsyncBuilderImpl.historicProcessInstanceQuery
(HistoricProcessInstanceQuery historicProcessInstanceQuery) RestartProcessInstanceBuilderImpl.historicProcessInstanceQuery
(HistoricProcessInstanceQuery query) ManagementServiceImpl.setJobRetriesAsync
(List<String> processInstanceIds, ProcessInstanceQuery query, HistoricProcessInstanceQuery historicProcessInstanceQuery, int retries) RuntimeServiceImpl.setVariablesAsync
(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, Map<String, ?> variables) RuntimeServiceImpl.setVariablesAsync
(HistoricProcessInstanceQuery historicProcessInstanceQuery, Map<String, ?> variables) ModifierConstructorDescriptionSetJobsRetriesByProcessBatchCmd
(List<String> processInstanceIds, ProcessInstanceQuery query, HistoricProcessInstanceQuery historicProcessInstanceQuery, int retries, Date dueDate, boolean isDueDateSet) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl.cmd
Modifier and TypeFieldDescriptionprotected HistoricProcessInstanceQuery
UpdateExternalTaskRetriesBuilderImpl.historicProcessInstanceQuery
Modifier and TypeMethodDescriptionUpdateExternalTaskRetriesBuilderImpl.getHistoricProcessInstanceQuery()
Modifier and TypeMethodDescriptionUpdateExternalTaskRetriesBuilderImpl.historicProcessInstanceQuery
(HistoricProcessInstanceQuery historicProcessInstanceQuery) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl.cmd.batch
Modifier and TypeFieldDescriptionprotected HistoricProcessInstanceQuery
CorrelateAllMessageBatchCmd.historicProcessInstanceQuery
protected HistoricProcessInstanceQuery
DeleteHistoricProcessInstancesBatchCmd.historicProcessInstanceQuery
protected HistoricProcessInstanceQuery
DeleteProcessInstanceBatchCmd.historicProcessInstanceQuery
ModifierConstructorDescriptionDeleteHistoricProcessInstancesBatchCmd
(List<String> historicProcessInstanceIds, HistoricProcessInstanceQuery historicProcessInstanceQuery, String deleteReason) DeleteProcessInstanceBatchCmd
(List<String> processInstances, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, String deleteReason, boolean skipCustomListeners, boolean skipSubprocesses) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl.cmd.batch.variables
Modifier and TypeFieldDescriptionprotected HistoricProcessInstanceQuery
SetVariablesToProcessInstancesBatchCmd.historicProcessInstanceQuery
ModifierConstructorDescriptionSetVariablesToProcessInstancesBatchCmd
(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, Map<String, ?> variables) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl.history
Modifier and TypeFieldDescriptionprotected HistoricProcessInstanceQuery
SetRemovalTimeToHistoricProcessInstancesBuilderImpl.query
Modifier and TypeMethodDescriptionSetRemovalTimeToHistoricProcessInstancesBuilderImpl.byQuery
(HistoricProcessInstanceQuery query) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl.management
Modifier and TypeFieldDescriptionprotected HistoricProcessInstanceQuery
SetJobRetriesByProcessAsyncBuilderImpl.historicProcessInstanceQuery
Modifier and TypeMethodDescriptionSetJobRetriesByProcessAsyncBuilderImpl.historicProcessInstanceQuery
(HistoricProcessInstanceQuery query) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl.runtime
Modifier and TypeMethodDescriptionUpdateProcessInstanceSuspensionStateBuilderImpl.byHistoricProcessInstanceQuery
(HistoricProcessInstanceQuery historicProcessInstanceQuery) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.management
Modifier and TypeMethodDescriptionSetJobRetriesByProcessAsyncBuilder.historicProcessInstanceQuery
(HistoricProcessInstanceQuery query) Specifies a historic process instance query that identifies runtime process instances with jobs that have to be modified. -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.rest.dto.history
Modifier and TypeMethodDescriptionprotected HistoricProcessInstanceQuery
HistoricProcessInstanceQueryDto.createNewQuery
(ProcessEngine engine) Modifier and TypeMethodDescriptionprotected void
HistoricProcessInstanceQueryDto.applyFilters
(HistoricProcessInstanceQuery query) protected void
HistoricProcessInstanceQueryDto.applySortBy
(HistoricProcessInstanceQuery query, String sortBy, Map<String, Object> parameters, ProcessEngine engine) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.runtime
Modifier and TypeMethodDescriptionUpdateProcessInstancesRequest.byHistoricProcessInstanceQuery
(HistoricProcessInstanceQuery historicProcessInstanceQuery) Selects a list of process instances with the given a historical process instance query.MessageCorrelationAsyncBuilder.historicProcessInstanceQuery
(HistoricProcessInstanceQuery historicProcessInstanceQuery) Correlate the message such that the process instances found by the given query are selected.RestartProcessInstanceBuilder.historicProcessInstanceQuery
(HistoricProcessInstanceQuery query) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.test.assertions.bpmn
Modifier and TypeMethodDescriptionprotected HistoricProcessInstanceQuery
AbstractProcessAssert.historicProcessInstanceQuery()
protected HistoricProcessInstanceQuery
ProcessInstanceAssert.historicProcessInstanceQuery()
startedAfter(Date)
andstartedBefore(Date)
instead