Uses of Interface
org.camunda.bpm.engine.externaltask.ExternalTaskQuery
-
Packages that use ExternalTaskQuery Package Description org.camunda.bpm.engine Public API of the Camunda Platform engine.
Typical usage of the API starts by the creation of aProcessEngineConfiguration
(typically based on a configuration file), from which aProcessEngine
can be obtained.
Through the services obtained from such aProcessEngine
, BPM and workflow operation can be executed:
RepositoryService
: ManagesDeployment
s
RuntimeService
: For starting and searchingProcessInstance
s
TaskService
: Exposes operations to manage human (standalone)Task
s, such as claiming, completing and assigning tasks
IdentityService
: Used for managingUser
s,Group
s and the relations between them
ManagementService
: Exposes engine admin and maintenance operations, which have no relation to the runtime execution of business processes
HistoryService
: 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.test.assertions.bpmn -
-
Uses of ExternalTaskQuery in org.camunda.bpm.engine
Methods in org.camunda.bpm.engine that return ExternalTaskQuery Modifier and Type Method Description ExternalTaskQuery
ExternalTaskService. 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
Methods in org.camunda.bpm.engine with parameters of type ExternalTaskQuery Modifier and Type Method Description Batch
ExternalTaskService. 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
Methods in org.camunda.bpm.engine.externaltask that return ExternalTaskQuery Modifier and Type Method Description ExternalTaskQuery
ExternalTaskQuery. active()
Only select external tasks that are currently not suspendedExternalTaskQuery
ExternalTaskQuery. activityId(String activityId)
Only select external tasks that belong to an instance of the given activityExternalTaskQuery
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 executionExternalTaskQuery
ExternalTaskQuery. externalTaskId(String externalTaskId)
Only select the external task with the given idExternalTaskQuery
ExternalTaskQuery. externalTaskIdIn(Set<String> externalTaskIds)
Only select external tasks with any of the given idsExternalTaskQuery
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 dateExternalTaskQuery
ExternalTaskQuery. lockExpirationBefore(Date lockExpirationDate)
Only select external tasks that have a lock expiring before the given dateExternalTaskQuery
ExternalTaskQuery. noRetriesLeft()
Only select external tasks that have retries = 0ExternalTaskQuery
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 byQuery.asc()
orQuery.desc()
).ExternalTaskQuery
ExternalTaskQuery. orderByLockExpirationTime()
Order by lock expiration time (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery
ExternalTaskQuery. orderByPriority()
Order by priority (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery
ExternalTaskQuery. orderByProcessDefinitionId()
Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery
ExternalTaskQuery. orderByProcessDefinitionKey()
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery
ExternalTaskQuery. orderByProcessInstanceId()
Order by process instance id (needs to be followed byQuery.asc()
orQuery.desc()
).ExternalTaskQuery
ExternalTaskQuery. orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.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 definitionExternalTaskQuery
ExternalTaskQuery. processInstanceId(String processInstanceId)
Only select external tasks created in the context of the given process instanceExternalTaskQuery
ExternalTaskQuery. processInstanceIdIn(String... processInstanceIdIn)
Only select external tasks created in the context of the given process instancesExternalTaskQuery
ExternalTaskQuery. suspended()
Only select external tasks that are currently suspendedExternalTaskQuery
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 topicExternalTaskQuery
ExternalTaskQuery. withRetriesLeft()
Only select external tasks that have retries > 0ExternalTaskQuery
ExternalTaskQuery. workerId(String workerId)
Only select external tasks that was most recently locked by the given workerMethods in org.camunda.bpm.engine.externaltask with parameters of type ExternalTaskQuery Modifier and Type Method Description UpdateExternalTaskRetriesBuilder
UpdateExternalTaskRetriesSelectBuilder. externalTaskQuery(ExternalTaskQuery externalTaskQuery)
Selects a list of external tasks with the given external task query. -
Uses of ExternalTaskQuery in org.camunda.bpm.engine.impl
Classes in org.camunda.bpm.engine.impl that implement ExternalTaskQuery Modifier and Type Class Description class
ExternalTaskQueryImpl
Methods in org.camunda.bpm.engine.impl with parameters of type ExternalTaskQuery Modifier and Type Method Description Batch
ExternalTaskServiceImpl. setRetriesAsync(List<String> externalTaskIds, ExternalTaskQuery externalTaskQuery, int retries)
-
Uses of ExternalTaskQuery in org.camunda.bpm.engine.impl.cmd
Fields in org.camunda.bpm.engine.impl.cmd declared as ExternalTaskQuery Modifier and Type Field Description protected ExternalTaskQuery
UpdateExternalTaskRetriesBuilderImpl. externalTaskQuery
Methods in org.camunda.bpm.engine.impl.cmd that return ExternalTaskQuery Modifier and Type Method Description ExternalTaskQuery
UpdateExternalTaskRetriesBuilderImpl. getExternalTaskQuery()
Methods in org.camunda.bpm.engine.impl.cmd with parameters of type ExternalTaskQuery Modifier and Type Method Description UpdateExternalTaskRetriesBuilder
UpdateExternalTaskRetriesBuilderImpl. externalTaskQuery(ExternalTaskQuery externalTaskQuery)
-
Uses of ExternalTaskQuery in org.camunda.bpm.engine.rest.dto.externaltask
Methods in org.camunda.bpm.engine.rest.dto.externaltask that return ExternalTaskQuery Modifier and Type Method Description protected ExternalTaskQuery
ExternalTaskQueryDto. createNewQuery(ProcessEngine engine)
Methods in org.camunda.bpm.engine.rest.dto.externaltask with parameters of type ExternalTaskQuery Modifier and Type Method Description protected 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
Methods in org.camunda.bpm.engine.test.assertions.bpmn that return ExternalTaskQuery Modifier and Type Method Description protected ExternalTaskQuery
AbstractProcessAssert. externalTaskQuery()
static ExternalTaskQuery
BpmnAwareTests. externalTaskQuery()
Helper method to easily create a new ExternalTaskQueryprotected ExternalTaskQuery
ProcessInstanceAssert. externalTaskQuery()
Methods in org.camunda.bpm.engine.test.assertions.bpmn with parameters of type ExternalTaskQuery Modifier and Type Method Description static 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.ExternalTaskAssert
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.
-