Uses of Interface
org.camunda.bpm.engine.externaltask.ExternalTaskQuery
Package
Description
Public API of the Camunda Platform engine.
Typical usage of the API starts by the creation of a
Through the services obtained from such a
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.API implementation classes, which shouldn't directly be used by end-users.
-
Uses of ExternalTaskQuery in org.camunda.bpm.engine
Modifier and TypeMethodDescriptionExternalTaskService.createExternalTaskQuery()
Queries for tasks that the currently authenticated user has at least one of the following permissions for:Permissions.READ
onResources.PROCESS_INSTANCE
Permissions.READ_INSTANCE
onResources.PROCESS_DEFINITION
Modifier and TypeMethodDescriptionExternalTaskService.setRetriesAsync
(List<String> externalTaskIds, ExternalTaskQuery externalTaskQuery, int retries) Sets the retries for external tasks asynchronously as batch. -
Uses of ExternalTaskQuery in org.camunda.bpm.engine.externaltask
Modifier and TypeMethodDescriptionExternalTaskQuery.active()
Only select external tasks that are currently not suspendedExternalTaskQuery.activityId
(String activityId) Only select external tasks that belong to an instance of the given activityExternalTaskQuery.activityIdIn
(String... activityIdIn) Only select external tasks that belong to an instances of the given activities.ExternalTaskQuery.executionId
(String executionId) Only select external tasks created in the context of the given executionExternalTaskQuery.externalTaskId
(String externalTaskId) Only select the external task with the given idExternalTaskQuery.externalTaskIdIn
(Set<String> externalTaskIds) Only select external tasks with any of the given idsExternalTaskQuery.locked()
Only select external tasks that are currently locked, i.e.ExternalTaskQuery.lockExpirationAfter
(Date lockExpirationDate) Only select external tasks that have a lock expiring after the given dateExternalTaskQuery.lockExpirationBefore
(Date lockExpirationDate) Only select external tasks that have a lock expiring before the given dateExternalTaskQuery.noRetriesLeft()
Only select external tasks that have retries = 0ExternalTaskQuery.notLocked()
Only select external tasks that are not currently locked, i.e.ExternalTaskQuery.orderByCreateTime()
Order by create time (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery.orderById()
Order by external task id (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery.orderByLockExpirationTime()
Order by lock expiration time (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery.orderByPriority()
Order by priority (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery.orderByProcessDefinitionId()
Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery.orderByProcessDefinitionKey()
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery.orderByProcessInstanceId()
Order by process instance id (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery.orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery.priorityHigherThanOrEquals
(long priority) Only select external tasks with a priority that is higher than or equal to the given priority.ExternalTaskQuery.priorityLowerThanOrEquals
(long priority) Only select external tasks with a priority that is lower than or equal to the given priority.ExternalTaskQuery.processDefinitionId
(String processDefinitionId) Only select external tasks that belong to an instance of the given process definitionExternalTaskQuery.processInstanceId
(String processInstanceId) Only select external tasks created in the context of the given process instanceExternalTaskQuery.processInstanceIdIn
(String... processInstanceIdIn) Only select external tasks created in the context of the given process instancesExternalTaskQuery.suspended()
Only select external tasks that are currently suspendedExternalTaskQuery.tenantIdIn
(String... tenantIds) Only select external tasks that belong to one of the given tenant ids.Only select external tasks of the given topicExternalTaskQuery.withRetriesLeft()
Only select external tasks that have retries > 0Only select external tasks that was most recently locked by the given workerModifier and TypeMethodDescriptionUpdateExternalTaskRetriesSelectBuilder.externalTaskQuery
(ExternalTaskQuery externalTaskQuery) Selects a list of external tasks with the given external task query. -
Uses of ExternalTaskQuery in org.camunda.bpm.engine.impl
Modifier and TypeMethodDescriptionExternalTaskQueryImpl.active()
ExternalTaskQueryImpl.activityId
(String activityId) ExternalTaskQueryImpl.activityIdIn
(String... activityIdIn) ExternalTaskServiceImpl.createExternalTaskQuery()
ExternalTaskQueryImpl.executionId
(String executionId) ExternalTaskQueryImpl.externalTaskId
(String externalTaskId) ExternalTaskQueryImpl.externalTaskIdIn
(Set<String> externalTaskIds) ExternalTaskQueryImpl.locked()
ExternalTaskQueryImpl.lockExpirationAfter
(Date lockExpirationDate) ExternalTaskQueryImpl.lockExpirationBefore
(Date lockExpirationDate) ExternalTaskQueryImpl.noRetriesLeft()
ExternalTaskQueryImpl.notLocked()
ExternalTaskQueryImpl.orderByCreateTime()
ExternalTaskQueryImpl.orderById()
ExternalTaskQueryImpl.orderByLockExpirationTime()
ExternalTaskQueryImpl.orderByPriority()
ExternalTaskQueryImpl.orderByProcessDefinitionId()
ExternalTaskQueryImpl.orderByProcessDefinitionKey()
ExternalTaskQueryImpl.orderByProcessInstanceId()
ExternalTaskQueryImpl.orderByTenantId()
ExternalTaskQueryImpl.priorityHigherThanOrEquals
(long priority) ExternalTaskQueryImpl.priorityLowerThanOrEquals
(long priority) ExternalTaskQueryImpl.processDefinitionId
(String processDefinitionId) ExternalTaskQueryImpl.processInstanceId
(String processInstanceId) ExternalTaskQueryImpl.processInstanceIdIn
(String... processInstanceIdIn) ExternalTaskQueryImpl.suspended()
ExternalTaskQueryImpl.tenantIdIn
(String... tenantIds) ExternalTaskQueryImpl.withRetriesLeft()
Modifier and TypeMethodDescriptionExternalTaskServiceImpl.setRetriesAsync
(List<String> externalTaskIds, ExternalTaskQuery externalTaskQuery, int retries) -
Uses of ExternalTaskQuery in org.camunda.bpm.engine.impl.cmd
Modifier and TypeFieldDescriptionprotected ExternalTaskQuery
UpdateExternalTaskRetriesBuilderImpl.externalTaskQuery
Modifier and TypeMethodDescriptionUpdateExternalTaskRetriesBuilderImpl.externalTaskQuery
(ExternalTaskQuery externalTaskQuery) -
Uses of ExternalTaskQuery in org.camunda.bpm.engine.rest.dto.externaltask
Modifier and TypeFieldDescriptionstatic final Map<String,
Consumer<ExternalTaskQuery>> ExternalTaskQueryDto.SORT_METHODS_BY_FIELD
Modifier and TypeMethodDescriptionprotected ExternalTaskQuery
ExternalTaskQueryDto.createNewQuery
(ProcessEngine engine) Modifier and TypeMethodDescriptionprotected void
ExternalTaskQueryDto.applyFilters
(ExternalTaskQuery query) protected void
ExternalTaskQueryDto.applySortBy
(ExternalTaskQuery query, String sortBy, Map<String, Object> parameters, ProcessEngine engine) -
Uses of ExternalTaskQuery in org.camunda.bpm.engine.test.assertions.bpmn
Modifier and TypeMethodDescriptionprotected ExternalTaskQuery
AbstractProcessAssert.externalTaskQuery()
static ExternalTaskQuery
BpmnAwareTests.externalTaskQuery()
Helper method to easily create a new ExternalTaskQueryprotected ExternalTaskQuery
ProcessInstanceAssert.externalTaskQuery()
Modifier and TypeMethodDescriptionstatic ExternalTask
BpmnAwareTests.externalTask
(ExternalTaskQuery externalTaskQuery) Helper method to easily access the only external task compliant to a given externalTaskQuery and currently available in the context of the last asserted process instance.static ExternalTask
BpmnAwareTests.externalTask
(ExternalTaskQuery externalTaskQuery, ProcessInstance processInstance) Helper method to easily access the only external task compliant to a given externalTaskQuery and currently available in the context of the given process instance.ProcessInstanceAssert.externalTask
(ExternalTaskQuery query) Enter into a chained external task assert inspecting only external tasks currently available in the context of the process instance under test of this ProcessInstanceAssert.