| 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.batch | |
| org.camunda.bpm.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.camunda.bpm.engine.impl.batch | |
| org.camunda.bpm.engine.rest.dto.batch | |
| org.camunda.bpm.engine.rest.impl |
| Modifier and Type | Method and Description |
|---|---|
BatchQuery |
ManagementService.createBatchQuery()
Creates a query to search for
Batch instances. |
| Modifier and Type | Method and Description |
|---|---|
BatchQuery |
BatchQuery.active()
Only selects batches which are active
|
BatchQuery |
BatchQuery.batchId(String batchId)
Only select batch instances for the given batch id.
|
BatchQuery |
BatchQuery.orderById()
Returns batches sorted by id; must be followed by an invocation of
Query.asc() or Query.desc(). |
BatchQuery |
BatchQuery.orderByTenantId()
Returns batches sorted by tenant id; must be followed by an invocation of
Query.asc() or Query.desc(). |
BatchQuery |
BatchQuery.suspended()
Only selects batches which are suspended
|
BatchQuery |
BatchQuery.tenantIdIn(String... tenantIds)
Only selects batches with one of the given tenant ids.
|
BatchQuery |
BatchQuery.type(String type)
Only select batches of the given type.
|
BatchQuery |
BatchQuery.withoutTenantId()
Only selects batches which have no tenant id.
|
| Modifier and Type | Method and Description |
|---|---|
BatchQuery |
ManagementServiceImpl.createBatchQuery() |
| Modifier and Type | Class and Description |
|---|---|
class |
BatchQueryImpl |
| Modifier and Type | Method and Description |
|---|---|
BatchQuery |
BatchQueryImpl.active() |
BatchQuery |
BatchQueryImpl.batchId(String batchId) |
BatchQuery |
BatchQueryImpl.orderById() |
BatchQuery |
BatchQueryImpl.orderByTenantId() |
BatchQuery |
BatchQueryImpl.suspended() |
BatchQuery |
BatchQueryImpl.tenantIdIn(String... tenantIds) |
BatchQuery |
BatchQueryImpl.type(String type) |
BatchQuery |
BatchQueryImpl.withoutTenantId() |
| Modifier and Type | Method and Description |
|---|---|
protected BatchQuery |
BatchQueryDto.createNewQuery(ProcessEngine engine) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
BatchQueryDto.applyFilters(BatchQuery query) |
protected void |
BatchQueryDto.applySortBy(BatchQuery query,
String sortBy,
Map<String,Object> parameters,
ProcessEngine engine) |
| Modifier and Type | Method and Description |
|---|---|
protected List<Batch> |
BatchRestServiceImpl.executePaginatedQuery(BatchQuery query,
Integer firstResult,
Integer maxResults) |
Copyright © 2021. All rights reserved.