| Package | Description |
|---|---|
| org.camunda.bpm.engine |
Public API of the camunda BPM 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.authorization | |
| org.camunda.bpm.engine.filter | |
| org.camunda.bpm.engine.history |
Classes related to the
HistoryService. |
| org.camunda.bpm.engine.identity |
classes related to the
IdentityService. |
| 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.cmmn.entity.repository | |
| org.camunda.bpm.engine.impl.cmmn.entity.runtime | |
| org.camunda.bpm.engine.impl.filter | |
| org.camunda.bpm.engine.impl.identity.db | |
| org.camunda.bpm.engine.impl.persistence.entity | |
| org.camunda.bpm.engine.management |
Classes related to the
ManagementService. |
| org.camunda.bpm.engine.query |
Classes related to the querying entities in the engine.
|
| org.camunda.bpm.engine.repository |
Classes related to the
RepositoryService. |
| org.camunda.bpm.engine.rest.dto | |
| org.camunda.bpm.engine.rest.dto.task | |
| org.camunda.bpm.engine.rest.sub.runtime.impl | |
| org.camunda.bpm.engine.runtime |
Classes related to the
RuntimeService. |
| org.camunda.bpm.engine.task |
Classes related to the
TaskService. |
| org.camunda.bpm.identity.impl.ldap |
| Modifier and Type | Method and Description |
|---|---|
<T,Q extends Query<?,T>> |
FilterService.list(String filterId,
Q extendingQuery)
Executes the extended query of a filter and returns the result as list.
|
<T,Q extends Query<?,T>> |
FilterService.listPage(String filterId,
Q extendingQuery,
int firstResult,
int maxResults)
Executes the extended query of a filter and returns the result in the given boundaries as list.
|
<T,Q extends Query<?,T>> |
FilterService.singleResult(String filterId,
Q extendingQuery)
Executes the extended query of the filter and returns the a single result.
|
| Modifier and Type | Method and Description |
|---|---|
Long |
FilterService.count(String filterId,
Query<?,?> extendingQuery)
Executes the extended query of the filter and returns the result count.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AuthorizationQuery |
| Modifier and Type | Interface and Description |
|---|---|
interface |
FilterQuery |
| Modifier and Type | Method and Description |
|---|---|
<T extends Query<?,?>> |
Filter.extend(T extendingQuery)
Extends the query with the additional query.
|
<T extends Query<?,?>> |
Filter.getQuery() |
<T extends Query<?,?>> |
Filter.setQuery(T query) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
HistoricActivityInstanceQuery
Programmatic querying for
HistoricActivityInstances. |
interface |
HistoricActivityStatisticsQuery |
interface |
HistoricCaseActivityInstanceQuery
Programmatic querying for
HistoricCaseActivityInstances. |
interface |
HistoricCaseInstanceQuery
Allows programmatic querying of
HistoricCaseInstances. |
interface |
HistoricDetailQuery
Programmatic querying for
HistoricDetails. |
interface |
HistoricIncidentQuery |
interface |
HistoricJobLogQuery |
interface |
HistoricProcessInstanceQuery
Allows programmatic querying of
HistoricProcessInstances. |
interface |
HistoricTaskInstanceQuery
Allows programmatic querying for
HistoricTaskInstances. |
interface |
HistoricVariableInstanceQuery
Programmatic querying for
HistoricVariableInstances. |
interface |
UserOperationLogQuery
Programmatic querying for
UserOperationLogEntry instances. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
GroupQuery
Allows to programmatically query for
Groups. |
interface |
UserQuery
Allows programmatic querying of
User |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractQuery<T extends Query<?,?>,U>
Abstract superclass for all query types.
|
class |
AbstractVariableQueryImpl<T extends Query<?,?>,U>
Abstract query class that adds methods to query for variable values.
|
| Modifier and Type | Method and Description |
|---|---|
<T,Q extends Query<?,T>> |
FilterServiceImpl.list(String filterId,
Q extendingQuery) |
<T,Q extends Query<?,T>> |
FilterServiceImpl.listPage(String filterId,
Q extendingQuery,
int firstResult,
int maxResults) |
<T,Q extends Query<?,T>> |
FilterServiceImpl.singleResult(String filterId,
Q extendingQuery) |
| Modifier and Type | Method and Description |
|---|---|
Long |
FilterServiceImpl.count(String filterId,
Query<?,?> extendingQuery) |
| Modifier and Type | Field and Description |
|---|---|
protected Query<?,?> |
AbstractExecuteFilterCmd.extendingQuery |
| Modifier and Type | Method and Description |
|---|---|
protected Query<?,?> |
AbstractExecuteFilterCmd.getFilterQuery(CommandContext commandContext) |
| Constructor and Description |
|---|
AbstractExecuteFilterCmd(String filterId,
Query<?,?> extendingQuery) |
ExecuteFilterCountCmd(String filterId,
Query<?,?> extendingQuery) |
ExecuteFilterListCmd(String filterId,
Query<?,?> extendingQuery) |
ExecuteFilterListPageCmd(String filterId,
Query<?,?> extendingQuery,
int firstResult,
int maxResults) |
ExecuteFilterSingleResultCmd(String filterId,
Query<?,?> extendingQuery) |
| Modifier and Type | Class and Description |
|---|---|
class |
CaseDefinitionQueryImpl |
| Modifier and Type | Class and Description |
|---|---|
class |
CaseExecutionQueryImpl |
class |
CaseInstanceQueryImpl |
class |
CaseSentryPartQueryImpl
This query is currently not public API on purpose.
|
| Modifier and Type | Class and Description |
|---|---|
class |
FilterQueryImpl |
| Modifier and Type | Class and Description |
|---|---|
class |
DbGroupQueryImpl |
class |
DbUserQueryImpl |
| Modifier and Type | Method and Description |
|---|---|
<T extends Query<?,?>> |
FilterEntity.extend(T extendingQuery) |
<T extends Query<?,?>> |
FilterEntity.getQuery() |
<T extends Query<?,?>> |
FilterEntity.setQuery(T query) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ActivityStatisticsQuery |
interface |
DeploymentStatisticsQuery |
interface |
JobDefinitionQuery
Allows programmatic querying of
JobDefinitions. |
interface |
ProcessDefinitionStatisticsQuery |
| Modifier and Type | Interface and Description |
|---|---|
interface |
Query<T extends Query<?,?>,U>
Describes basic methods for querying.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
CaseDefinitionQuery |
interface |
DeploymentQuery
Allows programmatic querying of
Deployments. |
interface |
ProcessDefinitionQuery
Allows programmatic querying of
ProcessDefinitions. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractQueryDto<T extends Query<?,?>>
Defines common query operations, such as sorting options and validation.
|
| Modifier and Type | Method and Description |
|---|---|
static TaskQueryDto |
TaskQueryDto.fromQuery(Query<?,?> query) |
| Modifier and Type | Method and Description |
|---|---|
protected Query |
FilterResourceImpl.convertQuery(String queryString) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
CaseExecutionQuery |
interface |
CaseInstanceQuery |
interface |
EventSubscriptionQuery
Allows querying of event subscriptions.
|
interface |
ExecutionQuery
Allows programmatic querying of
Executions. |
interface |
IncidentQuery |
interface |
JobQuery
Allows programmatic querying of
Jobs. |
interface |
ProcessInstanceQuery
Allows programmatic querying of
ProcessInstances. |
interface |
VariableInstanceQuery |
| Modifier and Type | Interface and Description |
|---|---|
interface |
TaskQuery
Allows programmatic querying of
Tasks; |
| Modifier and Type | Class and Description |
|---|---|
class |
LdapGroupQuery |
class |
LdapUserQueryImpl |
Copyright © 2018. All rights reserved.