Uses of Interface
org.camunda.bpm.engine.history.HistoricProcessInstanceQuery
-
Packages that use HistoricProcessInstanceQuery Package Description org.camunda.bpm.engine Public API of the Camunda Platform engine.
Typical usage of the API starts by the creation of aProcessEngineConfiguration(typically based on a configuration file), from which aProcessEnginecan be obtained.
Through the services obtained from such aProcessEngine, BPM and workflow operation can be executed:
RepositoryService: ManagesDeployments
RuntimeService: For starting and searchingProcessInstances
TaskService: Exposes operations to manage human (standalone)Tasks, such as claiming, completing and assigning tasks
IdentityService: Used for managingUsers,Groups and the relations between them
ManagementService: Exposes engine admin and maintenance operations, which have no relation to the runtime execution 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.org.camunda.bpm.engine.externaltask org.camunda.bpm.engine.history Classes related to theHistoryService.org.camunda.bpm.engine.impl API implementation classes, which shouldn't directly be used by end-users.org.camunda.bpm.engine.impl.cmd org.camunda.bpm.engine.impl.cmd.batch org.camunda.bpm.engine.impl.cmd.batch.variables org.camunda.bpm.engine.impl.history org.camunda.bpm.engine.impl.runtime org.camunda.bpm.engine.rest.dto.history org.camunda.bpm.engine.runtime Classes related to theRuntimeService. -
-
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine
Methods in org.camunda.bpm.engine that return HistoricProcessInstanceQuery Modifier and Type Method Description HistoricProcessInstanceQueryHistoryService. createHistoricProcessInstanceQuery()Creates a new programmatic query to search forHistoricProcessInstances.Methods in org.camunda.bpm.engine with parameters of type HistoricProcessInstanceQuery Modifier and Type Method Description BatchHistoryService. deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, HistoricProcessInstanceQuery query, String deleteReason)Deletes historic process instances asynchronously based on query and a list of process instances.BatchHistoryService. deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query, String deleteReason)Deletes historic process instances asynchronously based on query.BatchRuntimeService. deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, String deleteReason, boolean skipCustomListeners, boolean skipSubprocesses)Delete an existing runtime process instances asynchronously using Batch operation.BatchManagementService. setJobRetriesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, int retries)Sets the number of retries that jobs have left asynchronously.BatchRuntimeService. setVariablesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, Map<String,?> variables)Update or create runtime process variables in the root scope of process instances.BatchRuntimeService. 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
Methods in org.camunda.bpm.engine.externaltask with parameters of type HistoricProcessInstanceQuery Modifier and Type Method Description UpdateExternalTaskRetriesBuilderUpdateExternalTaskRetriesSelectBuilder. 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
Methods in org.camunda.bpm.engine.history that return HistoricProcessInstanceQuery Modifier and Type Method Description HistoricProcessInstanceQueryHistoricProcessInstanceQuery. active()Only select historic process instances that are active.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. activeActivityIdIn(String... ids)Only select historic process instances that have active activities with given ids.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. caseInstanceId(String caseInstanceId)Only select historic process instances which are associated with the given case instance id.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. completed()Only select historic process instances that are completed.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. endOr()endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. executedActivityAfter(Date date)Only select historic process instances that executed an activity after the given date.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. executedActivityBefore(Date date)Only select historic process instances that executed an activity before the given date.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. executedActivityIdIn(String... ids)Only select historic process instances that executed activities with given ids.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. executedJobAfter(Date date)Only select historic process instances that executed an job after the given date.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. executedJobBefore(Date date)Only select historic process instances that executed an job before the given date.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. externallyTerminated()Only select historic process instances that are externallyTerminated.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. finishDateBy(Date date)Deprecated.usestartedAfter(Date)andstartedBefore(Date)insteadHistoricProcessInstanceQueryHistoricProcessInstanceQuery. finishDateOn(Date date)Deprecated.usestartedAfter(Date)andstartedBefore(Date)insteadHistoricProcessInstanceQueryHistoricProcessInstanceQuery. finished()Only select historic process instances that are completely finished.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. finishedAfter(Date date)Only select historic process instances that were started after the given date.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. finishedBefore(Date date)Only select historic process instances that were started before the given date.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. incidentMessage(String incidentMessage)Only select historic process instances with the given incident message.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. incidentMessageLike(String incidentMessageLike)Only select historic process instances which had an incident message like the given value.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. incidentStatus(String status)Only select historic process instances with incident status either 'open' or 'resolved'.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. incidentType(String incidentType)Only selects process instances with the given incident type.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. internallyTerminated()Only select historic process instances that are internallyTerminated.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. matchVariableNamesIgnoreCase()The query will match the names of variables in a case-insensitive way.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. matchVariableValuesIgnoreCase()The query will match the values of variables in a case-insensitive way.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. or()After calling or(), a chain of several filter criteria could follow.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. orderByProcessDefinitionId()Order by the process definition id (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryHistoricProcessInstanceQuery. orderByProcessDefinitionKey()Order by the process definition key (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryHistoricProcessInstanceQuery. orderByProcessDefinitionName()Order by the process definition name (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryHistoricProcessInstanceQuery. orderByProcessDefinitionVersion()Order by the process definition version (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryHistoricProcessInstanceQuery. orderByProcessInstanceBusinessKey()Order by the business key (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryHistoricProcessInstanceQuery. orderByProcessInstanceDuration()Order by the duration of the process instance (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryHistoricProcessInstanceQuery. orderByProcessInstanceEndTime()Order by the end time (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryHistoricProcessInstanceQuery. orderByProcessInstanceId()Order by the process instance id (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryHistoricProcessInstanceQuery. orderByProcessInstanceStartTime()Order by the start time (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryHistoricProcessInstanceQuery. orderByTenantId()Order by tenant id (needs to be followed byQuery.asc()orQuery.desc()).HistoricProcessInstanceQueryHistoricProcessInstanceQuery. processDefinitionId(String processDefinitionId)Only select historic process instances for the given process definitionHistoricProcessInstanceQueryHistoricProcessInstanceQuery. processDefinitionKey(String processDefinitionKey)Only select historic process instances that are defined by a process definition with the given key.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. processDefinitionKeyIn(String... processDefinitionKeys)Only select historic process instances that are defined by any given process definition key.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. 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 listHistoricProcessInstanceQueryHistoricProcessInstanceQuery. processDefinitionName(String processDefinitionName)Only select historic process instances that are defined by a process definition with the given name.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. processDefinitionNameLike(String nameLike)Only select historic process instances that are defined by process definition which name is like the given value.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. processInstanceBusinessKey(String processInstanceBusinessKey)Only select historic process instances with the given business keyHistoricProcessInstanceQueryHistoricProcessInstanceQuery. processInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)Only select historic process instances which had a business key like the given value.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. processInstanceId(String processInstanceId)Only select historic process instances with the given process instance.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. processInstanceIds(Set<String> processInstanceIds)Only select historic process instances whose id is in the given set of ids.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. rootProcessInstances()Only select historic process instances that are top level process instances.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. startDateBy(Date date)Deprecated.usestartedAfter(Date)andstartedBefore(Date)insteadHistoricProcessInstanceQueryHistoricProcessInstanceQuery. startDateOn(Date date)Deprecated.usestartedAfter(Date)andstartedBefore(Date)insteadHistoricProcessInstanceQueryHistoricProcessInstanceQuery. startedAfter(Date date)Only select historic process instances that were started after the given date.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. startedBefore(Date date)Only select historic process instances that were started before the given date.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. startedBy(String userId)Only select historic process instance that are started by the given user.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. subCaseInstanceId(String subCaseInstanceId)Only select historic process instances having a sub case instance with the given case instance id.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. subProcessInstanceId(String subProcessInstanceId)Only select historic process instances having a sub process instance with the given process instance id.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. superCaseInstanceId(String superCaseInstanceId)Only select historic process instances started by the given case instance.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. superProcessInstanceId(String superProcessInstanceId)Only select historic process instances started by the given process instance.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. suspended()Only select historic process instances that are suspended.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. tenantIdIn(String... tenantIds)Only select historic process instances with one of the given tenant ids.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. unfinished()Only select historic process instance that are not yet finished.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. variableValueEquals(String name, Object value)Only select process instances which had a global variable with the given value when they ended.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. variableValueGreaterThan(String name, Object value)Only select process instances which had a global variable value greater than the passed value when they ended.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. 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.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. variableValueLessThan(String name, Object value)Only select process instances which had a global variable value less than the passed value when the ended.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. 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.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. variableValueLike(String name, String value)Only select process instances which had global variable value like the given value when they ended.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. 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.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. withIncidents()Only select historic process instances with incidentsHistoricProcessInstanceQueryHistoricProcessInstanceQuery. withoutTenantId()Only selects historic process instances which have no tenant id.HistoricProcessInstanceQueryHistoricProcessInstanceQuery. withRootIncidents()Only select historic process instances with root incidentsMethods in org.camunda.bpm.engine.history with parameters of type HistoricProcessInstanceQuery Modifier and Type Method Description SetRemovalTimeToHistoricProcessInstancesBuilderSetRemovalTimeToHistoricProcessInstancesBuilder. byQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)Selects historic process instances by the given query. -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl
Classes in org.camunda.bpm.engine.impl that implement HistoricProcessInstanceQuery Modifier and Type Class Description classHistoricProcessInstanceQueryImplFields in org.camunda.bpm.engine.impl declared as HistoricProcessInstanceQuery Modifier and Type Field Description protected HistoricProcessInstanceQueryMessageCorrelationAsyncBuilderImpl. historicProcessInstanceQueryprotected HistoricProcessInstanceQuerySetJobsRetriesByProcessBatchCmd. historicProcessInstanceQueryprotected HistoricProcessInstanceQueryUpdateProcessInstancesSuspensionStateBuilderImpl. historicProcessInstanceQueryprotected HistoricProcessInstanceQueryRestartProcessInstanceBuilderImpl. queryMethods in org.camunda.bpm.engine.impl with parameters of type HistoricProcessInstanceQuery Modifier and Type Method Description UpdateProcessInstancesSuspensionStateBuilderUpdateProcessInstancesSuspensionStateBuilderImpl. byHistoricProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)BatchHistoryServiceImpl. deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, HistoricProcessInstanceQuery query, String deleteReason)BatchHistoryServiceImpl. deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query, String deleteReason)BatchRuntimeServiceImpl. deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, String deleteReason, boolean skipCustomListeners, boolean skipSubprocesses)MessageCorrelationAsyncBuilderMessageCorrelationAsyncBuilderImpl. historicProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)RestartProcessInstanceBuilderRestartProcessInstanceBuilderImpl. historicProcessInstanceQuery(HistoricProcessInstanceQuery query)BatchManagementServiceImpl. setJobRetriesAsync(List<String> processInstanceIds, ProcessInstanceQuery query, HistoricProcessInstanceQuery historicProcessInstanceQuery, int retries)BatchRuntimeServiceImpl. setVariablesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, Map<String,?> variables)BatchRuntimeServiceImpl. setVariablesAsync(HistoricProcessInstanceQuery historicProcessInstanceQuery, Map<String,?> variables)Constructors in org.camunda.bpm.engine.impl with parameters of type HistoricProcessInstanceQuery Constructor Description SetJobsRetriesByProcessBatchCmd(List<String> processInstanceIds, ProcessInstanceQuery query, HistoricProcessInstanceQuery historicProcessInstanceQuery, int retries) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl.cmd
Fields in org.camunda.bpm.engine.impl.cmd declared as HistoricProcessInstanceQuery Modifier and Type Field Description protected HistoricProcessInstanceQueryUpdateExternalTaskRetriesBuilderImpl. historicProcessInstanceQueryMethods in org.camunda.bpm.engine.impl.cmd that return HistoricProcessInstanceQuery Modifier and Type Method Description HistoricProcessInstanceQueryUpdateExternalTaskRetriesBuilderImpl. getHistoricProcessInstanceQuery()Methods in org.camunda.bpm.engine.impl.cmd with parameters of type HistoricProcessInstanceQuery Modifier and Type Method Description UpdateExternalTaskRetriesBuilderUpdateExternalTaskRetriesBuilderImpl. historicProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl.cmd.batch
Fields in org.camunda.bpm.engine.impl.cmd.batch declared as HistoricProcessInstanceQuery Modifier and Type Field Description protected HistoricProcessInstanceQueryCorrelateAllMessageBatchCmd. historicProcessInstanceQueryprotected HistoricProcessInstanceQueryDeleteHistoricProcessInstancesBatchCmd. historicProcessInstanceQueryprotected HistoricProcessInstanceQueryDeleteProcessInstanceBatchCmd. historicProcessInstanceQueryConstructors in org.camunda.bpm.engine.impl.cmd.batch with parameters of type HistoricProcessInstanceQuery Constructor Description DeleteHistoricProcessInstancesBatchCmd(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
Fields in org.camunda.bpm.engine.impl.cmd.batch.variables declared as HistoricProcessInstanceQuery Modifier and Type Field Description protected HistoricProcessInstanceQuerySetVariablesToProcessInstancesBatchCmd. historicProcessInstanceQueryConstructors in org.camunda.bpm.engine.impl.cmd.batch.variables with parameters of type HistoricProcessInstanceQuery Constructor Description SetVariablesToProcessInstancesBatchCmd(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, Map<String,?> variables) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl.history
Fields in org.camunda.bpm.engine.impl.history declared as HistoricProcessInstanceQuery Modifier and Type Field Description protected HistoricProcessInstanceQuerySetRemovalTimeToHistoricProcessInstancesBuilderImpl. queryMethods in org.camunda.bpm.engine.impl.history that return HistoricProcessInstanceQuery Modifier and Type Method Description HistoricProcessInstanceQuerySetRemovalTimeToHistoricProcessInstancesBuilderImpl. getQuery()Methods in org.camunda.bpm.engine.impl.history with parameters of type HistoricProcessInstanceQuery Modifier and Type Method Description SetRemovalTimeToHistoricProcessInstancesBuilderSetRemovalTimeToHistoricProcessInstancesBuilderImpl. byQuery(HistoricProcessInstanceQuery query) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.impl.runtime
Methods in org.camunda.bpm.engine.impl.runtime with parameters of type HistoricProcessInstanceQuery Modifier and Type Method Description UpdateProcessInstancesSuspensionStateBuilderUpdateProcessInstanceSuspensionStateBuilderImpl. byHistoricProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.rest.dto.history
Methods in org.camunda.bpm.engine.rest.dto.history that return HistoricProcessInstanceQuery Modifier and Type Method Description protected HistoricProcessInstanceQueryHistoricProcessInstanceQueryDto. createNewQuery(ProcessEngine engine)Methods in org.camunda.bpm.engine.rest.dto.history with parameters of type HistoricProcessInstanceQuery Modifier and Type Method Description protected voidHistoricProcessInstanceQueryDto. applyFilters(HistoricProcessInstanceQuery query)protected voidHistoricProcessInstanceQueryDto. applySortBy(HistoricProcessInstanceQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine) -
Uses of HistoricProcessInstanceQuery in org.camunda.bpm.engine.runtime
Methods in org.camunda.bpm.engine.runtime with parameters of type HistoricProcessInstanceQuery Modifier and Type Method Description UpdateProcessInstancesSuspensionStateBuilderUpdateProcessInstancesRequest. byHistoricProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)Selects a list of process instances with the given a historical process instance query.MessageCorrelationAsyncBuilderMessageCorrelationAsyncBuilder. historicProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)Correlate the message such that the process instances found by the given query are selected.RestartProcessInstanceBuilderRestartProcessInstanceBuilder. historicProcessInstanceQuery(HistoricProcessInstanceQuery query)
-