Package | Description |
---|---|
org.camunda.bpm.engine |
Public API of the Camunda Platform engine.
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. |
org.camunda.bpm.engine.externaltask | |
org.camunda.bpm.engine.history |
Classes related to the
HistoryService . |
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 the
RuntimeService . |
Modifier and Type | Method and Description |
---|---|
HistoricProcessInstanceQuery |
HistoryService.createHistoricProcessInstanceQuery()
Creates a new programmatic query to search for
HistoricProcessInstance s. |
Modifier and Type | Method and Description |
---|---|
Batch |
HistoryService.deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query,
String deleteReason)
Deletes historic process instances asynchronously based on query.
|
Batch |
HistoryService.deleteHistoricProcessInstancesAsync(List<String> processInstanceIds,
HistoricProcessInstanceQuery query,
String deleteReason)
Deletes historic process instances asynchronously based on query and a list of process instances.
|
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 |
ManagementService.setJobRetriesAsync(List<String> processInstanceIds,
ProcessInstanceQuery processInstanceQuery,
HistoricProcessInstanceQuery historicProcessInstanceQuery,
int retries)
Sets the number of retries that jobs have left asynchronously.
|
Batch |
RuntimeService.setVariablesAsync(HistoricProcessInstanceQuery historicProcessInstanceQuery,
Map<String,?> variables)
Update or create runtime process variables in the root scope of process instances.
|
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.
|
Modifier and Type | Method and Description |
---|---|
UpdateExternalTaskRetriesBuilder |
UpdateExternalTaskRetriesSelectBuilder.historicProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)
Selects a list of external tasks with the given historic process instance query.
|
Modifier and Type | Method and Description |
---|---|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.active()
Only select historic process instances that are active.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.activeActivityIdIn(String... ids)
Only select historic process instances that have active activities with given ids.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.caseInstanceId(String caseInstanceId)
Only select historic process instances which are associated with the given case instance id.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.completed()
Only select historic process instances that are completed.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.endOr()
endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.executedActivityAfter(Date date)
Only select historic process instances that executed an activity after the given date.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.executedActivityBefore(Date date)
Only select historic process instances that executed an activity before the given date.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.executedActivityIdIn(String... ids)
Only select historic process instances that executed activities with given ids.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.executedJobAfter(Date date)
Only select historic process instances that executed an job after the given date.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.executedJobBefore(Date date)
Only select historic process instances that executed an job before the given date.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.externallyTerminated()
Only select historic process instances that are externallyTerminated.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.finishDateBy(Date date)
Deprecated.
use
startedAfter(Date) and startedBefore(Date) instead |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.finishDateOn(Date date)
Deprecated.
use
startedAfter(Date) and startedBefore(Date) instead |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.finished()
Only select historic process instances that are completely finished.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.finishedAfter(Date date)
Only select historic process instances that were started after the given date.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.finishedBefore(Date date)
Only select historic process instances that were started before the given date.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.incidentMessage(String incidentMessage)
Only select historic process instances with the given incident message.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.incidentMessageLike(String incidentMessageLike)
Only select historic process instances which had an incident message like the given value.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.incidentStatus(String status)
Only select historic process instances with incident status either 'open' or 'resolved'.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.incidentType(String incidentType)
Only selects process instances with the given incident type.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.internallyTerminated()
Only select historic process instances that are internallyTerminated.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.matchVariableNamesIgnoreCase()
The query will match the names of variables in a case-insensitive way.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.matchVariableValuesIgnoreCase()
The query will match the values of variables in a case-insensitive way.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.or()
After calling or(), a chain of several filter criteria could follow.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.orderByProcessDefinitionId()
Order by the process definition id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.orderByProcessDefinitionKey()
Order by the process definition key (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.orderByProcessDefinitionName()
Order by the process definition name (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.orderByProcessDefinitionVersion()
Order by the process definition version (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.orderByProcessInstanceBusinessKey()
Order by the business key (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.orderByProcessInstanceDuration()
Order by the duration of the process instance (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.orderByProcessInstanceEndTime()
Order by the end time (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.orderByProcessInstanceId()
Order by the process instance id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.orderByProcessInstanceStartTime()
Order by the start time (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.orderByTenantId()
Order by tenant id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.processDefinitionId(String processDefinitionId)
Only select historic process instances for the given process definition
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.processDefinitionKey(String processDefinitionKey)
Only select historic process instances that are defined by a process
definition with the given key.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.processDefinitionKeyIn(String... processDefinitionKeys)
Only select historic process instances that are defined by any given process
definition key.
|
HistoricProcessInstanceQuery |
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 list
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.processDefinitionName(String processDefinitionName)
Only select historic process instances that are defined by a process
definition with the given name.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.processDefinitionNameLike(String nameLike)
Only select historic process instances that are defined by process definition which name
is like the given value.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.processInstanceBusinessKey(String processInstanceBusinessKey)
Only select historic process instances with the given business key
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.processInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)
Only select historic process instances which had a business key like the given value.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.processInstanceId(String processInstanceId)
Only select historic process instances with the given process instance.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.processInstanceIds(Set<String> processInstanceIds)
Only select historic process instances whose id is in the given set of ids.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.rootProcessInstances()
Only select historic process instances that are top level process instances.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.startDateBy(Date date)
Deprecated.
use
startedAfter(Date) and startedBefore(Date) instead |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.startDateOn(Date date)
Deprecated.
use
startedAfter(Date) and startedBefore(Date) instead |
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.startedAfter(Date date)
Only select historic process instances that were started after the given date.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.startedBefore(Date date)
Only select historic process instances that were started before the given date.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.startedBy(String userId)
Only select historic process instance that are started by the given user.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.subCaseInstanceId(String subCaseInstanceId)
Only select historic process instances having a sub case instance
with the given case instance id.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.subProcessInstanceId(String subProcessInstanceId)
Only select historic process instances having a sub process instance
with the given process instance id.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.superCaseInstanceId(String superCaseInstanceId)
Only select historic process instances started by the given case
instance.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.superProcessInstanceId(String superProcessInstanceId)
Only select historic process instances started by the given process
instance.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.suspended()
Only select historic process instances that are suspended.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.tenantIdIn(String... tenantIds)
Only select historic process instances with one of the given tenant ids.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.unfinished()
Only select historic process instance that are not yet finished.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.variableValueEquals(String name,
Object value)
Only select process instances which had a global variable with the given value
when they ended.
|
HistoricProcessInstanceQuery |
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 |
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 |
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 |
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 |
HistoricProcessInstanceQuery.variableValueLike(String name,
String value)
Only select process instances which had global variable value like the given value
when they ended.
|
HistoricProcessInstanceQuery |
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 |
HistoricProcessInstanceQuery.withIncidents()
Only select historic process instances with incidents
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.withoutTenantId()
Only selects historic process instances which have no tenant id.
|
HistoricProcessInstanceQuery |
HistoricProcessInstanceQuery.withRootIncidents()
Only select historic process instances with root incidents
|
Modifier and Type | Method and Description |
---|---|
SetRemovalTimeToHistoricProcessInstancesBuilder |
SetRemovalTimeToHistoricProcessInstancesBuilder.byQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)
Selects historic process instances by the given query.
|
Modifier and Type | Class and Description |
---|---|
class |
HistoricProcessInstanceQueryImpl |
Modifier and Type | Field and Description |
---|---|
protected HistoricProcessInstanceQuery |
UpdateProcessInstancesSuspensionStateBuilderImpl.historicProcessInstanceQuery |
protected HistoricProcessInstanceQuery |
SetJobsRetriesByProcessBatchCmd.historicProcessInstanceQuery |
protected HistoricProcessInstanceQuery |
RestartProcessInstanceBuilderImpl.query |
Modifier and Type | Method and Description |
---|---|
UpdateProcessInstancesSuspensionStateBuilder |
UpdateProcessInstancesSuspensionStateBuilderImpl.byHistoricProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery) |
Batch |
HistoryServiceImpl.deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query,
String deleteReason) |
Batch |
HistoryServiceImpl.deleteHistoricProcessInstancesAsync(List<String> processInstanceIds,
HistoricProcessInstanceQuery query,
String deleteReason) |
Batch |
RuntimeServiceImpl.deleteProcessInstancesAsync(List<String> processInstanceIds,
ProcessInstanceQuery processInstanceQuery,
HistoricProcessInstanceQuery historicProcessInstanceQuery,
String deleteReason,
boolean skipCustomListeners,
boolean skipSubprocesses) |
RestartProcessInstanceBuilder |
RestartProcessInstanceBuilderImpl.historicProcessInstanceQuery(HistoricProcessInstanceQuery query) |
Batch |
ManagementServiceImpl.setJobRetriesAsync(List<String> processInstanceIds,
ProcessInstanceQuery query,
HistoricProcessInstanceQuery historicProcessInstanceQuery,
int retries) |
Batch |
RuntimeServiceImpl.setVariablesAsync(HistoricProcessInstanceQuery historicProcessInstanceQuery,
Map<String,?> variables) |
Batch |
RuntimeServiceImpl.setVariablesAsync(List<String> processInstanceIds,
ProcessInstanceQuery processInstanceQuery,
HistoricProcessInstanceQuery historicProcessInstanceQuery,
Map<String,?> variables) |
Constructor and Description |
---|
SetJobsRetriesByProcessBatchCmd(List<String> processInstanceIds,
ProcessInstanceQuery query,
HistoricProcessInstanceQuery historicProcessInstanceQuery,
int retries) |
Modifier and Type | Field and Description |
---|---|
protected HistoricProcessInstanceQuery |
UpdateExternalTaskRetriesBuilderImpl.historicProcessInstanceQuery |
Modifier and Type | Method and Description |
---|---|
HistoricProcessInstanceQuery |
UpdateExternalTaskRetriesBuilderImpl.getHistoricProcessInstanceQuery() |
Modifier and Type | Method and Description |
---|---|
UpdateExternalTaskRetriesBuilder |
UpdateExternalTaskRetriesBuilderImpl.historicProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery) |
Modifier and Type | Field and Description |
---|---|
protected HistoricProcessInstanceQuery |
DeleteProcessInstanceBatchCmd.historicProcessInstanceQuery |
protected HistoricProcessInstanceQuery |
DeleteHistoricProcessInstancesBatchCmd.historicProcessInstanceQuery |
Constructor and Description |
---|
DeleteHistoricProcessInstancesBatchCmd(List<String> historicProcessInstanceIds,
HistoricProcessInstanceQuery historicProcessInstanceQuery,
String deleteReason) |
DeleteProcessInstanceBatchCmd(List<String> processInstances,
ProcessInstanceQuery processInstanceQuery,
HistoricProcessInstanceQuery historicProcessInstanceQuery,
String deleteReason,
boolean skipCustomListeners,
boolean skipSubprocesses) |
Modifier and Type | Field and Description |
---|---|
protected HistoricProcessInstanceQuery |
SetVariablesToProcessInstancesBatchCmd.historicProcessInstanceQuery |
Constructor and Description |
---|
SetVariablesToProcessInstancesBatchCmd(List<String> processInstanceIds,
ProcessInstanceQuery processInstanceQuery,
HistoricProcessInstanceQuery historicProcessInstanceQuery,
Map<String,?> variables) |
Modifier and Type | Field and Description |
---|---|
protected HistoricProcessInstanceQuery |
SetRemovalTimeToHistoricProcessInstancesBuilderImpl.query |
Modifier and Type | Method and Description |
---|---|
HistoricProcessInstanceQuery |
SetRemovalTimeToHistoricProcessInstancesBuilderImpl.getQuery() |
Modifier and Type | Method and Description |
---|---|
SetRemovalTimeToHistoricProcessInstancesBuilder |
SetRemovalTimeToHistoricProcessInstancesBuilderImpl.byQuery(HistoricProcessInstanceQuery query) |
Modifier and Type | Method and Description |
---|---|
UpdateProcessInstancesSuspensionStateBuilder |
UpdateProcessInstanceSuspensionStateBuilderImpl.byHistoricProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery) |
Modifier and Type | Method and Description |
---|---|
protected HistoricProcessInstanceQuery |
HistoricProcessInstanceQueryDto.createNewQuery(ProcessEngine engine) |
Modifier and Type | Method and Description |
---|---|
protected void |
HistoricProcessInstanceQueryDto.applyFilters(HistoricProcessInstanceQuery query) |
protected void |
HistoricProcessInstanceQueryDto.applySortBy(HistoricProcessInstanceQuery query,
String sortBy,
Map<String,Object> parameters,
ProcessEngine engine) |
Modifier and Type | Method and Description |
---|---|
UpdateProcessInstancesSuspensionStateBuilder |
UpdateProcessInstancesRequest.byHistoricProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)
Selects a list of process instances with the given a historical process instance query.
|
RestartProcessInstanceBuilder |
RestartProcessInstanceBuilder.historicProcessInstanceQuery(HistoricProcessInstanceQuery query) |
Copyright © 2022. All rights reserved.