Uses of Interface
org.camunda.bpm.engine.runtime.ProcessInstanceQuery
-
Packages that use ProcessInstanceQuery 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 aProcessEngine
can be obtained.
Through the services obtained from such aProcessEngine
, BPM and workflow operation can be executed:
RepositoryService
: ManagesDeployment
s
RuntimeService
: For starting and searchingProcessInstance
s
TaskService
: Exposes operations to manage human (standalone)Task
s, such as claiming, completing and assigning tasks
IdentityService
: Used for managingUser
s,Group
s 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.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.management org.camunda.bpm.engine.impl.migration org.camunda.bpm.engine.impl.runtime org.camunda.bpm.engine.management Classes related to theManagementService
.org.camunda.bpm.engine.migration org.camunda.bpm.engine.rest.dto.runtime org.camunda.bpm.engine.runtime Classes related to theRuntimeService
.org.camunda.bpm.engine.test.assertions.bpmn org.camunda.bpm.qa.upgrade -
-
Uses of ProcessInstanceQuery in org.camunda.bpm.engine
Methods in org.camunda.bpm.engine that return ProcessInstanceQuery Modifier and Type Method Description ProcessInstanceQuery
RuntimeService. createProcessInstanceQuery()
Creates a newProcessInstanceQuery
instance, that can be used to query process instances.Methods in org.camunda.bpm.engine with parameters of type ProcessInstanceQuery Modifier and Type Method Description Batch
RuntimeService. deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, String deleteReason)
Delete an existing runtime process instances asynchronously using Batch operation.Batch
RuntimeService. deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, String deleteReason, boolean skipCustomListeners)
Delete an existing runtime process instances asynchronously using Batch operation.Batch
RuntimeService. deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, String deleteReason, boolean skipCustomListeners, boolean skipSubprocesses)
Delete an existing runtime process instances asynchronously using Batch operation.Batch
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.Batch
RuntimeService. deleteProcessInstancesAsync(ProcessInstanceQuery processInstanceQuery, String deleteReason)
Delete an existing runtime process instances asynchronously using Batch operation.Batch
ManagementService. setJobRetriesAsync(List<String> processInstanceIds, ProcessInstanceQuery query, int retries)
Sets the number of retries that jobs have left asynchronously.Batch
ManagementService. setJobRetriesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, int retries)
Sets the number of retries that jobs have left asynchronously.Batch
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.Batch
RuntimeService. setVariablesAsync(ProcessInstanceQuery processInstanceQuery, Map<String,?> variables)
Update or create runtime process variables in the root scope of process instances. -
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.externaltask
Methods in org.camunda.bpm.engine.externaltask with parameters of type ProcessInstanceQuery Modifier and Type Method Description UpdateExternalTaskRetriesBuilder
UpdateExternalTaskRetriesSelectBuilder. processInstanceQuery(ProcessInstanceQuery processInstanceQuery)
Selects a list of external tasks with the given process instance query. -
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.impl
Classes in org.camunda.bpm.engine.impl that implement ProcessInstanceQuery Modifier and Type Class Description class
ProcessInstanceQueryImpl
Fields in org.camunda.bpm.engine.impl declared as ProcessInstanceQuery Modifier and Type Field Description protected ProcessInstanceQuery
MessageCorrelationAsyncBuilderImpl. processInstanceQuery
protected ProcessInstanceQuery
ModificationBuilderImpl. processInstanceQuery
protected ProcessInstanceQuery
UpdateProcessInstancesSuspensionStateBuilderImpl. processInstanceQuery
protected ProcessInstanceQuery
SetJobsRetriesByProcessBatchCmd. query
Methods in org.camunda.bpm.engine.impl with parameters of type ProcessInstanceQuery Modifier and Type Method Description UpdateProcessInstancesSuspensionStateBuilder
UpdateProcessInstancesSuspensionStateBuilderImpl. byProcessInstanceQuery(ProcessInstanceQuery processInstanceQuery)
Batch
RuntimeServiceImpl. deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, String deleteReason)
Batch
RuntimeServiceImpl. deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, String deleteReason, boolean skipCustomListeners)
Batch
RuntimeServiceImpl. deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, String deleteReason, boolean skipCustomListeners, boolean skipSubprocesses)
Batch
RuntimeServiceImpl. deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, String deleteReason, boolean skipCustomListeners, boolean skipSubprocesses)
Batch
RuntimeServiceImpl. deleteProcessInstancesAsync(ProcessInstanceQuery processInstanceQuery, String deleteReason)
MessageCorrelationAsyncBuilder
MessageCorrelationAsyncBuilderImpl. processInstanceQuery(ProcessInstanceQuery processInstanceQuery)
ModificationBuilder
ModificationBuilderImpl. processInstanceQuery(ProcessInstanceQuery processInstanceQuery)
Batch
ManagementServiceImpl. setJobRetriesAsync(List<String> processInstanceIds, ProcessInstanceQuery query, int retries)
Batch
ManagementServiceImpl. setJobRetriesAsync(List<String> processInstanceIds, ProcessInstanceQuery query, HistoricProcessInstanceQuery historicProcessInstanceQuery, int retries)
Batch
RuntimeServiceImpl. setVariablesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, Map<String,?> variables)
Batch
RuntimeServiceImpl. setVariablesAsync(ProcessInstanceQuery processInstanceQuery, Map<String,?> variables)
Constructors in org.camunda.bpm.engine.impl with parameters of type ProcessInstanceQuery Constructor Description SetJobsRetriesByProcessBatchCmd(List<String> processInstanceIds, ProcessInstanceQuery query, HistoricProcessInstanceQuery historicProcessInstanceQuery, int retries, Date dueDate, boolean isDueDateSet)
-
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.impl.cmd
Fields in org.camunda.bpm.engine.impl.cmd declared as ProcessInstanceQuery Modifier and Type Field Description protected ProcessInstanceQuery
UpdateExternalTaskRetriesBuilderImpl. processInstanceQuery
Methods in org.camunda.bpm.engine.impl.cmd that return ProcessInstanceQuery Modifier and Type Method Description ProcessInstanceQuery
UpdateExternalTaskRetriesBuilderImpl. getProcessInstanceQuery()
Methods in org.camunda.bpm.engine.impl.cmd with parameters of type ProcessInstanceQuery Modifier and Type Method Description UpdateExternalTaskRetriesBuilder
UpdateExternalTaskRetriesBuilderImpl. processInstanceQuery(ProcessInstanceQuery processInstanceQuery)
-
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.impl.cmd.batch
Fields in org.camunda.bpm.engine.impl.cmd.batch declared as ProcessInstanceQuery Modifier and Type Field Description protected ProcessInstanceQuery
CorrelateAllMessageBatchCmd. processInstanceQuery
protected ProcessInstanceQuery
DeleteProcessInstanceBatchCmd. processInstanceQuery
Constructors in org.camunda.bpm.engine.impl.cmd.batch with parameters of type ProcessInstanceQuery Constructor Description DeleteProcessInstanceBatchCmd(List<String> processInstances, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, String deleteReason, boolean skipCustomListeners, boolean skipSubprocesses)
-
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.impl.cmd.batch.variables
Fields in org.camunda.bpm.engine.impl.cmd.batch.variables declared as ProcessInstanceQuery Modifier and Type Field Description protected ProcessInstanceQuery
SetVariablesToProcessInstancesBatchCmd. processInstanceQuery
Constructors in org.camunda.bpm.engine.impl.cmd.batch.variables with parameters of type ProcessInstanceQuery Constructor Description SetVariablesToProcessInstancesBatchCmd(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, HistoricProcessInstanceQuery historicProcessInstanceQuery, Map<String,?> variables)
-
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.impl.management
Fields in org.camunda.bpm.engine.impl.management declared as ProcessInstanceQuery Modifier and Type Field Description protected ProcessInstanceQuery
SetJobRetriesByProcessAsyncBuilderImpl. processInstanceQuery
Methods in org.camunda.bpm.engine.impl.management with parameters of type ProcessInstanceQuery Modifier and Type Method Description SetJobRetriesByProcessAsyncBuilder
SetJobRetriesByProcessAsyncBuilderImpl. processInstanceQuery(ProcessInstanceQuery query)
-
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.impl.migration
Fields in org.camunda.bpm.engine.impl.migration declared as ProcessInstanceQuery Modifier and Type Field Description protected ProcessInstanceQuery
MigrationPlanExecutionBuilderImpl. processInstanceQuery
Methods in org.camunda.bpm.engine.impl.migration that return ProcessInstanceQuery Modifier and Type Method Description ProcessInstanceQuery
MigrationPlanExecutionBuilderImpl. getProcessInstanceQuery()
Methods in org.camunda.bpm.engine.impl.migration with parameters of type ProcessInstanceQuery Modifier and Type Method Description MigrationPlanExecutionBuilder
MigrationPlanExecutionBuilderImpl. processInstanceQuery(ProcessInstanceQuery processInstanceQuery)
-
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.impl.runtime
Methods in org.camunda.bpm.engine.impl.runtime with parameters of type ProcessInstanceQuery Modifier and Type Method Description UpdateProcessInstancesSuspensionStateBuilder
UpdateProcessInstanceSuspensionStateBuilderImpl. byProcessInstanceQuery(ProcessInstanceQuery processInstanceQuery)
-
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.management
Methods in org.camunda.bpm.engine.management with parameters of type ProcessInstanceQuery Modifier and Type Method Description SetJobRetriesByProcessAsyncBuilder
SetJobRetriesByProcessAsyncBuilder. processInstanceQuery(ProcessInstanceQuery query)
Specifies a process instance query. -
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.migration
Methods in org.camunda.bpm.engine.migration with parameters of type ProcessInstanceQuery Modifier and Type Method Description MigrationPlanExecutionBuilder
MigrationPlanExecutionBuilder. processInstanceQuery(ProcessInstanceQuery processInstanceQuery)
-
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.rest.dto.runtime
Methods in org.camunda.bpm.engine.rest.dto.runtime that return ProcessInstanceQuery Modifier and Type Method Description protected ProcessInstanceQuery
ProcessInstanceQueryDto. createNewQuery(ProcessEngine engine)
Methods in org.camunda.bpm.engine.rest.dto.runtime with parameters of type ProcessInstanceQuery Modifier and Type Method Description protected void
ProcessInstanceQueryDto. applyFilters(ProcessInstanceQuery query)
protected void
ProcessInstanceQueryDto. applySortBy(ProcessInstanceQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
-
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.runtime
Methods in org.camunda.bpm.engine.runtime that return ProcessInstanceQuery Modifier and Type Method Description ProcessInstanceQuery
ProcessInstanceQuery. active()
Only selects process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.ProcessInstanceQuery
ProcessInstanceQuery. activityIdIn(String... activityIds)
Only selects process instances with leaf activity instances or transition instances (async before, async after) in at least one of the given activity ids.ProcessInstanceQuery
ProcessInstanceQuery. caseInstanceId(String caseInstanceId)
Selects the process instances which are associated with the given case instance id.ProcessInstanceQuery
ProcessInstanceQuery. deploymentId(String deploymentId)
Selects the process instances which belong to the given deployment id.ProcessInstanceQuery
ProcessInstanceQuery. endOr()
endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied.ProcessInstanceQuery
ProcessInstanceQuery. incidentId(String incidentId)
Only selects process instances with the given incident id.ProcessInstanceQuery
ProcessInstanceQuery. incidentMessage(String incidentMessage)
Only selects process instances with the given incident message.ProcessInstanceQuery
ProcessInstanceQuery. incidentMessageLike(String incidentMessageLike)
Only selects process instances with an incident message like the given.ProcessInstanceQuery
ProcessInstanceQuery. incidentType(String incidentType)
Only selects process instances with the given incident type.ProcessInstanceQuery
ProcessInstanceQuery. leafProcessInstances()
Only selects process instances which don't have subprocesses and thus are leaves of the execution tree.ProcessInstanceQuery
ProcessInstanceQuery. matchVariableNamesIgnoreCase()
The query will match the names of process-variables in a case-insensitive way.ProcessInstanceQuery
ProcessInstanceQuery. matchVariableValuesIgnoreCase()
The query will match the values of process-variables in a case-insensitive way.ProcessInstanceQuery
ProcessInstanceQuery. or()
After calling or(), a chain of several filter criteria could follow.ProcessInstanceQuery
ProcessInstanceQuery. orderByBusinessKey()
Order by the business key (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery
ProcessInstanceQuery. orderByProcessDefinitionId()
Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery
ProcessInstanceQuery. orderByProcessDefinitionKey()
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery
ProcessInstanceQuery. orderByProcessInstanceId()
Order by id (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery
ProcessInstanceQuery. orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery
ProcessInstanceQuery. processDefinitionId(String processDefinitionId)
Selects the process instances which are defined by a process definition with the given id.ProcessInstanceQuery
ProcessInstanceQuery. processDefinitionKey(String processDefinitionKey)
Select the process instances which are defined by a process definition with the given key.ProcessInstanceQuery
ProcessInstanceQuery. processDefinitionKeyIn(String... processDefinitionKeys)
Select the process instances for any given process definition keys.ProcessInstanceQuery
ProcessInstanceQuery. processDefinitionKeyNotIn(String... processDefinitionKeys)
Select historic process instances that don't have a process-definition of which the key is present in the given listProcessInstanceQuery
ProcessInstanceQuery. processDefinitionWithoutTenantId()
Only selects process instances which process definition has no tenant id.ProcessInstanceQuery
ProcessInstanceQuery. processInstanceBusinessKey(String processInstanceBusinessKey)
Select process instances with the given business keyProcessInstanceQuery
ProcessInstanceQuery. processInstanceBusinessKey(String processInstanceBusinessKey, String processDefinitionKey)
Select process instance with the given business key, unique for the given process definitionProcessInstanceQuery
ProcessInstanceQuery. processInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)
Select process instances with a business key like the given value.ProcessInstanceQuery
ProcessInstanceQuery. processInstanceId(String processInstanceId)
Select the process instance with the given idProcessInstanceQuery
ProcessInstanceQuery. processInstanceIds(Set<String> processInstanceIds)
Select process instances whose id is in the given set of idsProcessInstanceQuery
ProcessInstanceQuery. rootProcessInstances()
Only selects process instances which are top level process instances.ProcessInstanceQuery
ProcessInstanceQuery. subCaseInstanceId(String subCaseInstanceId)
Select the process instance that has as sub case instance the given case instance.ProcessInstanceQuery
ProcessInstanceQuery. subProcessInstanceId(String subProcessInstanceId)
Select the process instance that have as sub process instance the given process instance.ProcessInstanceQuery
ProcessInstanceQuery. superCaseInstanceId(String superCaseInstanceId)
Select the process instances which are a sub process instance of the given super case instance.ProcessInstanceQuery
ProcessInstanceQuery. superProcessInstanceId(String superProcessInstanceId)
Select the process instances which are a sub process instance of the given super process instance.ProcessInstanceQuery
ProcessInstanceQuery. suspended()
Only selects process instances which are suspended, either because the process instance itself is suspended or because the corresponding process definition is suspendedProcessInstanceQuery
ProcessInstanceQuery. tenantIdIn(String... tenantIds)
Only select process instances with one of the given tenant ids.ProcessInstanceQuery
ProcessInstanceQuery. variableValueEquals(String name, Object value)
Only select process instances which have a global variable with the given value.ProcessInstanceQuery
ProcessInstanceQuery. variableValueGreaterThan(String name, Object value)
Only select process instances which have a variable value greater than the passed value.ProcessInstanceQuery
ProcessInstanceQuery. variableValueGreaterThanOrEqual(String name, Object value)
Only select process instances which have a global variable value greater than or equal to the passed value.ProcessInstanceQuery
ProcessInstanceQuery. variableValueLessThan(String name, Object value)
Only select process instances which have a global variable value less than the passed value.ProcessInstanceQuery
ProcessInstanceQuery. variableValueLessThanOrEqual(String name, Object value)
Only select process instances which have a global variable value less than or equal to the passed value.ProcessInstanceQuery
ProcessInstanceQuery. variableValueLike(String name, String value)
Only select process instances which have a global variable value like the given value.ProcessInstanceQuery
ProcessInstanceQuery. variableValueNotEquals(String name, Object value)
Only select process instances which have a global variable with the given name, but with a different value than the passed value.ProcessInstanceQuery
ProcessInstanceQuery. withIncident()
Only selects process instances with at least one incident.ProcessInstanceQuery
ProcessInstanceQuery. withoutTenantId()
Only selects process instances which have no tenant id.Methods in org.camunda.bpm.engine.runtime with parameters of type ProcessInstanceQuery Modifier and Type Method Description UpdateProcessInstancesSuspensionStateBuilder
UpdateProcessInstancesRequest. byProcessInstanceQuery(ProcessInstanceQuery processInstanceQuery)
Selects a list of process instances with the given a process instance query.MessageCorrelationAsyncBuilder
MessageCorrelationAsyncBuilder. processInstanceQuery(ProcessInstanceQuery processInstanceQuery)
Correlate the message such that the process instances found by the given query are selected.ModificationBuilder
ModificationBuilder. processInstanceQuery(ProcessInstanceQuery processInstanceQuery)
-
Uses of ProcessInstanceQuery in org.camunda.bpm.engine.test.assertions.bpmn
Methods in org.camunda.bpm.engine.test.assertions.bpmn that return ProcessInstanceQuery Modifier and Type Method Description protected ProcessInstanceQuery
AbstractProcessAssert. processInstanceQuery()
static ProcessInstanceQuery
BpmnAwareTests. processInstanceQuery()
Helper method to easily create a new ProcessInstanceQueryprotected ProcessInstanceQuery
ProcessDefinitionAssert. processInstanceQuery()
protected ProcessInstanceQuery
ProcessInstanceAssert. processInstanceQuery()
Methods in org.camunda.bpm.engine.test.assertions.bpmn with parameters of type ProcessInstanceQuery Modifier and Type Method Description static ProcessInstance
BpmnAwareTests. calledProcessInstance(ProcessInstanceQuery processInstanceQuery)
Helper method to easily access the only called process instance compliant to a given processInstanceQuery and currently available in the context of the last asserted process instance.static ProcessInstance
BpmnAwareTests. calledProcessInstance(ProcessInstanceQuery processInstanceQuery, ProcessInstance processInstance)
Helper method to easily access the only called process instance compliant to a given processInstanceQuery and currently available in the context of the given process instance.ProcessInstanceAssert
ProcessInstanceAssert. calledProcessInstance(ProcessInstanceQuery query)
Enter into a chained process instance assert inspecting a called process instance called by and currently available in the context of the process instance under test of this ProcessInstanceAssert. -
Uses of ProcessInstanceQuery in org.camunda.bpm.qa.upgrade
Methods in org.camunda.bpm.qa.upgrade that return ProcessInstanceQuery Modifier and Type Method Description ProcessInstanceQuery
UpgradeTestRule. processInstanceQuery()
-