Uses of Interface
org.camunda.bpm.engine.runtime.JobQuery
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.
Classes related to the
ManagementService
.Classes related to the
RuntimeService
.-
Uses of JobQuery in org.camunda.bpm.engine
Modifier and TypeMethodDescriptionManagementService.createJobQuery()
Returns a new JobQuery implementation, that can be used to dynamically query the jobs.Modifier and TypeMethodDescriptionManagementService.setJobRetriesAsync
(List<String> jobIds, JobQuery jobQuery, int retries) Sets the number of retries that jobs have left asynchronously.ManagementService.setJobRetriesAsync
(JobQuery jobQuery, int retries) Sets the number of retries that jobs have left asynchronously. -
Uses of JobQuery in org.camunda.bpm.engine.impl
Modifier and TypeMethodDescriptionJobQueryImpl.active()
JobQueryImpl.activityId
(String activityId) JobQueryImpl.createdAfter
(Date date) JobQueryImpl.createdBefore
(Date date) ManagementServiceImpl.createJobQuery()
JobQueryImpl.duedateHigherThan
(Date date) JobQueryImpl.duedateHigherThen
(Date date) JobQueryImpl.duedateHigherThenOrEquals
(Date date) JobQueryImpl.duedateLowerThan
(Date date) JobQueryImpl.duedateLowerThen
(Date date) JobQueryImpl.duedateLowerThenOrEquals
(Date date) JobQueryImpl.exceptionMessage
(String exceptionMessage) JobQueryImpl.executable()
JobQueryImpl.failedActivityId
(String activityId) JobQueryImpl.includeJobsWithoutTenantId()
JobQueryImpl.jobDefinitionId
(String jobDefinitionId) JobQueryImpl.messages()
JobQueryImpl.noRetriesLeft()
JobQueryImpl.orderByExecutionId()
JobQueryImpl.orderByJobDuedate()
JobQueryImpl.orderByJobId()
JobQueryImpl.orderByJobPriority()
JobQueryImpl.orderByJobRetries()
JobQueryImpl.orderByProcessDefinitionId()
JobQueryImpl.orderByProcessDefinitionKey()
JobQueryImpl.orderByProcessInstanceId()
JobQueryImpl.orderByTenantId()
JobQueryImpl.priorityHigherThanOrEquals
(long priority) JobQueryImpl.priorityLowerThanOrEquals
(long priority) JobQueryImpl.processDefinitionId
(String processDefinitionId) JobQueryImpl.processDefinitionKey
(String processDefinitionKey) JobQueryImpl.processInstanceIds
(Set<String> processInstanceIds) JobQueryImpl.suspended()
JobQueryImpl.tenantIdIn
(String... tenantIds) JobQueryImpl.timers()
JobQueryImpl.withException()
JobQueryImpl.withoutTenantId()
JobQueryImpl.withRetriesLeft()
Modifier and TypeMethodDescriptionManagementServiceImpl.setJobRetriesAsync
(List<String> jobIds, JobQuery jobQuery, int retries) ManagementServiceImpl.setJobRetriesAsync
(JobQuery jobQuery, int retries) -
Uses of JobQuery in org.camunda.bpm.engine.impl.cmd
ModifierConstructorDescriptionSetJobsRetriesBatchCmd
(List<String> ids, JobQuery jobQuery, int retries, Date dueDate, boolean isDueDateSet) -
Uses of JobQuery in org.camunda.bpm.engine.impl.management
Modifier and TypeMethodDescription -
Uses of JobQuery in org.camunda.bpm.engine.management
-
Uses of JobQuery in org.camunda.bpm.engine.rest.dto.runtime
Modifier and TypeMethodDescriptionprotected JobQuery
JobQueryDto.createNewQuery
(ProcessEngine engine) Modifier and TypeMethodDescriptionprotected void
JobQueryDto.applyFilters
(JobQuery query) protected void
JobQueryDto.applySortBy
(JobQuery query, String sortBy, Map<String, Object> parameters, ProcessEngine engine) -
Uses of JobQuery in org.camunda.bpm.engine.runtime
Modifier and TypeMethodDescriptionJobQuery.active()
Only select jobs that are not suspended.JobQuery.activityId
(String activityId) Only select jobs which are defined on an activity with the given id.JobQuery.createdAfter
(Date date) Only select jobs created after the given date.JobQuery.createdBefore
(Date date) Only select jobs created before the given date.JobQuery.duedateHigherThan
(Date date) Only select jobs where the duedate is higher then the given date.JobQuery.duedateHigherThen
(Date date) Deprecated.JobQuery.duedateHigherThenOrEquals
(Date date) Deprecated.JobQuery.duedateLowerThan
(Date date) Only select jobs where the duedate is lower than the given date.JobQuery.duedateLowerThen
(Date date) Deprecated.JobQuery.duedateLowerThenOrEquals
(Date date) Deprecated.JobQuery.exceptionMessage
(String exceptionMessage) Only select jobs that failed due to an exception with the given message.JobQuery.executable()
Only select jobs which are executable, ie.JobQuery.executionId
(String executionId) Only select jobs which exist for the given executionJobQuery.failedActivityId
(String activityId) Only select jobs that failed due to an exception at an activity with the given id.JobQuery.includeJobsWithoutTenantId()
Select jobs which have no tenant id.JobQuery.jobDefinitionId
(String jobDefinitionId) Only select jobs which exist for the given job definition id.Only select jobs with the given idOnly select jobs whose id is in the given set of idsJobQuery.messages()
Only select jobs that are messages.JobQuery.noRetriesLeft()
Only select jobs which have no retries leftJobQuery.orderByExecutionId()
Order by execution id (needs to be followed byQuery.asc()
orQuery.desc()
).JobQuery.orderByJobDuedate()
Order by duedate (needs to be followed byQuery.asc()
orQuery.desc()
).JobQuery.orderByJobId()
Order by job id (needs to be followed byQuery.asc()
orQuery.desc()
).JobQuery.orderByJobPriority()
Order by priority for execution (needs to be followed byQuery.asc()
orQuery.desc()
).JobQuery.orderByJobRetries()
Order by retries (needs to be followed byQuery.asc()
orQuery.desc()
).JobQuery.orderByProcessDefinitionId()
Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).JobQuery.orderByProcessDefinitionKey()
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).JobQuery.orderByProcessInstanceId()
Order by process instance id (needs to be followed byQuery.asc()
orQuery.desc()
).JobQuery.orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).JobQuery.priorityHigherThanOrEquals
(long priority) Only select jobs with a priority that is higher than or equal to the given priority.JobQuery.priorityLowerThanOrEquals
(long priority) Only select jobs with a priority that is lower than or equal to the given priority.JobQuery.processDefinitionId
(String processDefinitionId) Only select jobs which exist for the given process definition id.JobQuery.processDefinitionKey
(String processDefinitionKey) Only select jobs which exist for the given process definition key.JobQuery.processInstanceId
(String processInstanceId) Only select jobs which exist for the given process instance.JobQuery.processInstanceIds
(Set<String> processInstanceIds) Only select jobs which exist for any of the given process instance idsJobQuery.rootProcessInstanceId
(String rootProcessInstanceId) Only select jobs which exist for the given root process instance.JobQuery.suspended()
Only select jobs that are suspended.JobQuery.tenantIdIn
(String... tenantIds) Only select jobs that belong to one of the given tenant ids.JobQuery.timers()
Only select jobs that are timers.JobQuery.withException()
Only select jobs that failed due to an exception.JobQuery.withoutTenantId()
Only select jobs which have no tenant id.JobQuery.withRetriesLeft()
Only select jobs which have retries left -
Uses of JobQuery in org.camunda.bpm.engine.test.assertions.bpmn
Modifier and TypeMethodDescriptionprotected JobQuery
AbstractProcessAssert.jobQuery()
static JobQuery
BpmnAwareTests.jobQuery()
Helper method to easily create a new JobQueryprotected JobQuery
JobAssert.jobQuery()
protected JobQuery
ProcessInstanceAssert.jobQuery()
Modifier and TypeMethodDescriptionstatic Job
Helper method to easily access the only job compliant to a given jobQuery and currently available in the context of the last asserted process instance.static Job
BpmnAwareTests.job
(JobQuery jobQuery, ProcessInstance processInstance) Helper method to easily access the only job compliant to a given jobQuery and currently available in the context of the given process instance.Enter into a chained job assert inspecting only jobs currently available in the context of the process instance under test of this ProcessInstanceAssert. -
Uses of JobQuery in org.camunda.bpm.qa.upgrade