| 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 DeploymentsRuntimeService:
For starting and searching ProcessInstancesTaskService:
Exposes operations to manage human (standalone) Tasks,
such as claiming, completing and assigning tasksIdentityService:
Used for managing Users,
Groups 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.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.batch.removaltime | |
| org.camunda.bpm.engine.impl.dmn.cmd | |
| org.camunda.bpm.engine.impl.history | |
| org.camunda.bpm.engine.rest.dto.history |
| Modifier and Type | Method and Description |
|---|---|
HistoricDecisionInstanceQuery |
HistoryService.createHistoricDecisionInstanceQuery()
Creates a new programmatic query to search for
HistoricDecisionInstances. |
| Modifier and Type | Method and Description |
|---|---|
Batch |
HistoryService.deleteHistoricDecisionInstancesAsync(HistoricDecisionInstanceQuery query,
String deleteReason)
Deletes historic decision instances asynchronously based on query of decision instances.
|
Batch |
HistoryService.deleteHistoricDecisionInstancesAsync(List<String> decisionInstanceIds,
HistoricDecisionInstanceQuery query,
String deleteReason)
Deletes historic decision instances asynchronously based on query and a list of decision instances, whereby query result and
list of ids will be merged.
|
| Modifier and Type | Method and Description |
|---|---|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.activityIdIn(String... activityIds)
Only select historic decision instances that are evaluated inside a process or a case
which have one of the activity ids.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.activityInstanceIdIn(String... activityInstanceIds)
Only select historic decision instances that are evaluated inside a process or a case
which have one of the activity instance ids.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.caseDefinitionId(String caseDefinitionId)
Only select historic decision instances that are evaluated inside a case
with the given case definition id.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.caseDefinitionKey(String caseDefinitionKey)
Only select historic decision instances that are evaluated inside a case
with the given case definition key.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.caseInstanceId(String caseInstanceId)
Only select historic decision instances that are evaluated inside a case
with the given case instance id.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.decisionDefinitionId(String decisionDefinitionId)
Only select historic decision instances for the given decision definition
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.decisionDefinitionIdIn(String... decisionDefinitionIdIn)
Only select historic decision instances for the given decision definitions
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.decisionDefinitionKey(String decisionDefinitionKey)
Only select historic decision instances with the given key of the decision definition.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.decisionDefinitionKeyIn(String... decisionDefinitionKeyIn)
Only select historic decision instances with the given keys of the decision definition.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.decisionDefinitionName(String decisionDefinitionName)
Only select historic decision instances with the given name of the decision definition.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.decisionDefinitionNameLike(String decisionDefinitionNameLike)
Only select historic decision instances with the given name of the decision definition using LIKE construct.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.decisionInstanceId(String decisionInstanceId)
Only select historic decision instances with the given decision instance id.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.decisionInstanceIdIn(String... decisionInstanceIdIn)
Only select historic decision instances whose id is in the given list of ids.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.decisionRequirementsDefinitionId(String decisionRequirementsDefinitionId)
Only select historic decision instances that belongs to a decision requirements definition with the given id.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.decisionRequirementsDefinitionKey(String decisionRequirementsDefinitionKey)
Only select historic decision instances that belongs to a decision requirements definition with the given key.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.disableBinaryFetching()
Disable fetching of byte array input and output values.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.disableCustomObjectDeserialization()
Disable deserialization of input and output values that are custom objects.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.evaluatedAfter(Date date)
Only select historic decision instances that were evaluated after the given date.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.evaluatedBefore(Date date)
Only select historic decision instances that were evaluated before the given date.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.includeInputs()
Enable fetching
HistoricDecisionInputInstance of evaluated decision. |
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.includeOutputs()
Enable fetching
HistoricDecisionOutputInstance of evaluated decision. |
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.orderByEvaluationTime()
Order by the time when the decisions was evaluated
(needs to be followed by
Query.asc() or Query.desc()). |
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.orderByTenantId()
Order by tenant id (needs to be followed by
Query.asc() or Query.desc()). |
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.processDefinitionId(String processDefinitionId)
Only select historic decision instances that are evaluated inside a process
with the given process definition id.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.processDefinitionKey(String processDefinitionKey)
Only select historic decision instances that are evaluated inside a process
with the given process definition key.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.processInstanceId(String processInstanceId)
Only select historic decision instances that are evaluated inside a process
with the given process instance id.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.rootDecisionInstanceId(String decisionInstanceId)
Only select historic decision instances with a given root historic decision
instance id.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.rootDecisionInstancesOnly()
Only select historic decision instances that are the root decision instance of an evaluation.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.tenantIdIn(String... tenantIds)
Only select historic decision instances with one of the given tenant ids.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.userId(String userId)
Only select historic decision instances that were evaluated by the user with the given user ID.
|
HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQuery.withoutTenantId()
Only selects historic decision instances that have no tenant id.
|
| Modifier and Type | Method and Description |
|---|---|
SetRemovalTimeToHistoricDecisionInstancesBuilder |
SetRemovalTimeToHistoricDecisionInstancesBuilder.byQuery(HistoricDecisionInstanceQuery historicDecisionInstanceQuery)
Selects historic decision instances by the given query.
|
| Modifier and Type | Class and Description |
|---|---|
class |
HistoricDecisionInstanceQueryImpl |
| Modifier and Type | Method and Description |
|---|---|
Batch |
HistoryServiceImpl.deleteHistoricDecisionInstancesAsync(HistoricDecisionInstanceQuery query,
String deleteReason) |
Batch |
HistoryServiceImpl.deleteHistoricDecisionInstancesAsync(List<String> decisionInstanceIds,
HistoricDecisionInstanceQuery query,
String deleteReason) |
| Modifier and Type | Method and Description |
|---|---|
protected HistoricDecisionInstanceQuery |
SetRemovalTimeToHistoricDecisionInstancesCmd.createHistoricDecisionInstanceQuery(CommandContext commandContext) |
| Modifier and Type | Field and Description |
|---|---|
protected HistoricDecisionInstanceQuery |
DeleteHistoricDecisionInstancesBatchCmd.historicDecisionInstanceQuery |
| Constructor and Description |
|---|
DeleteHistoricDecisionInstancesBatchCmd(List<String> ids,
HistoricDecisionInstanceQuery query,
String deleteReason) |
| Modifier and Type | Field and Description |
|---|---|
protected HistoricDecisionInstanceQuery |
SetRemovalTimeToHistoricDecisionInstancesBuilderImpl.query |
| Modifier and Type | Method and Description |
|---|---|
HistoricDecisionInstanceQuery |
SetRemovalTimeToHistoricDecisionInstancesBuilderImpl.getQuery() |
| Modifier and Type | Method and Description |
|---|---|
SetRemovalTimeToHistoricDecisionInstancesBuilder |
SetRemovalTimeToHistoricDecisionInstancesBuilderImpl.byQuery(HistoricDecisionInstanceQuery query) |
| Modifier and Type | Method and Description |
|---|---|
protected HistoricDecisionInstanceQuery |
HistoricDecisionInstanceQueryDto.createNewQuery(ProcessEngine engine) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
HistoricDecisionInstanceQueryDto.applyFilters(HistoricDecisionInstanceQuery query) |
protected void |
HistoricDecisionInstanceQueryDto.applySortBy(HistoricDecisionInstanceQuery query,
String sortBy,
Map<String,Object> parameters,
ProcessEngine engine) |
Copyright © 2022. All rights reserved.