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 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.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
org.camunda.bpm.engine.impl.cmd | |
org.camunda.bpm.engine.rest.dto.externaltask | |
org.camunda.bpm.engine.rest.impl |
Modifier and Type | Method and Description |
---|---|
ExternalTaskQuery |
ExternalTaskService.createExternalTaskQuery()
Queries for tasks that the currently authenticated user has at least one
of the following permissions for:
Permissions.READ on Resources.PROCESS_INSTANCE
Permissions.READ_INSTANCE on Resources.PROCESS_DEFINITION
|
Modifier and Type | Method and Description |
---|---|
Batch |
ExternalTaskService.setRetriesAsync(List<String> externalTaskIds,
ExternalTaskQuery externalTaskQuery,
int retries)
Sets the retries for external tasks asynchronously as batch.
|
Modifier and Type | Method and Description |
---|---|
ExternalTaskQuery |
ExternalTaskQuery.active()
Only select external tasks that are currently not suspended
|
ExternalTaskQuery |
ExternalTaskQuery.activityId(String activityId)
Only select external tasks that belong to an instance of the given activity
|
ExternalTaskQuery |
ExternalTaskQuery.activityIdIn(String... activityIdIn)
Only select external tasks that belong to an instances of the given activities.
|
ExternalTaskQuery |
ExternalTaskQuery.executionId(String executionId)
Only select external tasks created in the context of the given execution
|
ExternalTaskQuery |
ExternalTaskQuery.externalTaskId(String externalTaskId)
Only select the external task with the given id
|
ExternalTaskQuery |
ExternalTaskQuery.locked()
Only select external tasks that are currently locked, i.e.
|
ExternalTaskQuery |
ExternalTaskQuery.lockExpirationAfter(Date lockExpirationDate)
Only select external tasks that have a lock expiring after the given date
|
ExternalTaskQuery |
ExternalTaskQuery.lockExpirationBefore(Date lockExpirationDate)
Only select external tasks that have a lock expiring before the given date
|
ExternalTaskQuery |
ExternalTaskQuery.noRetriesLeft()
Only select external tasks that have retries = 0
|
ExternalTaskQuery |
ExternalTaskQuery.notLocked()
Only select external tasks that are not currently locked, i.e.
|
ExternalTaskQuery |
ExternalTaskQuery.orderById()
Order by external task id (needs to be followed by
Query.asc() or Query.desc() ). |
ExternalTaskQuery |
ExternalTaskQuery.orderByLockExpirationTime()
Order by lock expiration time (needs to be followed by
Query.asc() or Query.desc() ). |
ExternalTaskQuery |
ExternalTaskQuery.orderByPriority()
Order by priority (needs to be followed by
Query.asc() or Query.desc() ). |
ExternalTaskQuery |
ExternalTaskQuery.orderByProcessDefinitionId()
Order by process definition id (needs to be followed by
Query.asc() or Query.desc() ). |
ExternalTaskQuery |
ExternalTaskQuery.orderByProcessDefinitionKey()
Order by process definition key (needs to be followed by
Query.asc() or Query.desc() ). |
ExternalTaskQuery |
ExternalTaskQuery.orderByProcessInstanceId()
Order by process instance id (needs to be followed by
Query.asc() or Query.desc() ). |
ExternalTaskQuery |
ExternalTaskQuery.orderByTenantId()
Order by tenant id (needs to be followed by
Query.asc() or Query.desc() ). |
ExternalTaskQuery |
ExternalTaskQuery.priorityHigherThanOrEquals(long priority)
Only select external tasks with a priority that is higher than or equal to the given priority.
|
ExternalTaskQuery |
ExternalTaskQuery.priorityLowerThanOrEquals(long priority)
Only select external tasks with a priority that is lower than or equal to the given priority.
|
ExternalTaskQuery |
ExternalTaskQuery.processDefinitionId(String processDefinitionId)
Only select external tasks that belong to an instance of the given process definition
|
ExternalTaskQuery |
ExternalTaskQuery.processInstanceId(String processInstanceId)
Only select external tasks created in the context of the given process instance
|
ExternalTaskQuery |
ExternalTaskQuery.processInstanceIdIn(String... processInstanceIdIn)
Only select external tasks created in the context of the given process instances
|
ExternalTaskQuery |
ExternalTaskQuery.suspended()
Only select external tasks that are currently suspended
|
ExternalTaskQuery |
ExternalTaskQuery.tenantIdIn(String... tenantIds)
Only select external tasks that belong to one of the given tenant ids.
|
ExternalTaskQuery |
ExternalTaskQuery.topicName(String topicName)
Only select external tasks of the given topic
|
ExternalTaskQuery |
ExternalTaskQuery.withRetriesLeft()
Only select external tasks that have retries > 0
|
ExternalTaskQuery |
ExternalTaskQuery.workerId(String workerId)
Only select external tasks that was most recently locked by the given worker
|
Modifier and Type | Method and Description |
---|---|
UpdateExternalTaskRetriesBuilder |
UpdateExternalTaskRetriesSelectBuilder.externalTaskQuery(ExternalTaskQuery externalTaskQuery)
Selects a list of external tasks with the given external task query.
|
Modifier and Type | Class and Description |
---|---|
class |
ExternalTaskQueryImpl |
Modifier and Type | Method and Description |
---|---|
Batch |
ExternalTaskServiceImpl.setRetriesAsync(List<String> externalTaskIds,
ExternalTaskQuery externalTaskQuery,
int retries) |
Modifier and Type | Field and Description |
---|---|
protected ExternalTaskQuery |
UpdateExternalTaskRetriesBuilderImpl.externalTaskQuery |
Modifier and Type | Method and Description |
---|---|
ExternalTaskQuery |
UpdateExternalTaskRetriesBuilderImpl.getExternalTaskQuery() |
Modifier and Type | Method and Description |
---|---|
UpdateExternalTaskRetriesBuilder |
UpdateExternalTaskRetriesBuilderImpl.externalTaskQuery(ExternalTaskQuery externalTaskQuery) |
Modifier and Type | Method and Description |
---|---|
protected ExternalTaskQuery |
ExternalTaskQueryDto.createNewQuery(ProcessEngine engine) |
Modifier and Type | Method and Description |
---|---|
protected void |
ExternalTaskQueryDto.applyFilters(ExternalTaskQuery query) |
protected void |
ExternalTaskQueryDto.applySortBy(ExternalTaskQuery query,
String sortBy,
Map<String,Object> parameters,
ProcessEngine engine) |
Modifier and Type | Method and Description |
---|---|
protected List<ExternalTask> |
ExternalTaskRestServiceImpl.executePaginatedQuery(ExternalTaskQuery query,
Integer firstResult,
Integer maxResults) |
Copyright © 2022. All rights reserved.