Package org.camunda.bpm.engine.runtime
Interface JobQuery
- All Known Implementing Classes:
JobQueryImpl
Allows programmatic querying of
Job
s.- Author:
- Joram Barrez, Falko Menge
-
Method Summary
Modifier and TypeMethodDescriptionactive()
Only select jobs that are not suspended.activityId
(String activityId) Only select jobs which are defined on an activity with the given id.createdAfter
(Date date) Only select jobs created after the given date.createdBefore
(Date date) Only select jobs created before the given date.duedateHigherThan
(Date date) Only select jobs where the duedate is higher then the given date.duedateHigherThen
(Date date) Deprecated.Deprecated.duedateLowerThan
(Date date) Only select jobs where the duedate is lower than the given date.duedateLowerThen
(Date date) Deprecated.duedateLowerThenOrEquals
(Date date) Deprecated.exceptionMessage
(String exceptionMessage) Only select jobs that failed due to an exception with the given message.Only select jobs which are executable, ie.executionId
(String executionId) Only select jobs which exist for the given executionfailedActivityId
(String activityId) Only select jobs that failed due to an exception at an activity with the given id.Select jobs which have no tenant id.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 idsmessages()
Only select jobs that are messages.Only select jobs which have no retries leftOrder by execution id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by duedate (needs to be followed byQuery.asc()
orQuery.desc()
).Order by job id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by priority for execution (needs to be followed byQuery.asc()
orQuery.desc()
).Order by retries (needs to be followed byQuery.asc()
orQuery.desc()
).Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).Order by process instance id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).priorityHigherThanOrEquals
(long priority) Only select jobs with a priority that is higher than or equal to the given priority.priorityLowerThanOrEquals
(long priority) Only select jobs with a priority that is lower than or equal to the given priority.processDefinitionId
(String processDefinitionId) Only select jobs which exist for the given process definition id.processDefinitionKey
(String processDefinitionKey) Only select jobs which exist for the given process definition key.processInstanceId
(String processInstanceId) Only select jobs which exist for the given process instance.processInstanceIds
(Set<String> processInstanceIds) Only select jobs which exist for any of the given process instance idsrootProcessInstanceId
(String rootProcessInstanceId) Only select jobs which exist for the given root process instance.Only select jobs that are suspended.tenantIdIn
(String... tenantIds) Only select jobs that belong to one of the given tenant ids.timers()
Only select jobs that are timers.Only select jobs that failed due to an exception.Only select jobs which have no tenant id.Only select jobs which have retries leftMethods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
Method Details
-
jobId
Only select jobs with the given id -
jobIds
Only select jobs whose id is in the given set of ids -
jobDefinitionId
Only select jobs which exist for the given job definition id. -
rootProcessInstanceId
Only select jobs which exist for the given root process instance. -
processInstanceId
Only select jobs which exist for the given process instance. -
processInstanceIds
Only select jobs which exist for any of the given process instance ids -
processDefinitionId
Only select jobs which exist for the given process definition id. -
processDefinitionKey
Only select jobs which exist for the given process definition key. -
executionId
Only select jobs which exist for the given execution -
activityId
Only select jobs which are defined on an activity with the given id. -
withRetriesLeft
JobQuery withRetriesLeft()Only select jobs which have retries left -
executable
JobQuery executable()Only select jobs which are executable, ie. retries > 0 and duedate is null or duedate is in the past -
timers
JobQuery timers()Only select jobs that are timers. Cannot be used together withmessages()
-
messages
JobQuery messages()Only select jobs that are messages. Cannot be used together withtimers()
-
duedateLowerThan
Only select jobs where the duedate is lower than the given date. -
duedateHigherThan
Only select jobs where the duedate is higher then the given date. -
duedateLowerThen
Deprecated.Only select jobs where the duedate is lower then the given date. -
duedateLowerThenOrEquals
Deprecated.Only select jobs where the duedate is lower then or equals the given date. -
duedateHigherThen
Deprecated.Only select jobs where the duedate is higher then the given date. -
duedateHigherThenOrEquals
Deprecated.Only select jobs where the duedate is higher then or equals the given date. -
createdBefore
Only select jobs created before the given date. -
createdAfter
Only select jobs created after the given date. -
priorityHigherThanOrEquals
Only select jobs with a priority that is higher than or equal to the given priority.- Since:
- 7.4
-
priorityLowerThanOrEquals
Only select jobs with a priority that is lower than or equal to the given priority.- Since:
- 7.4
-
withException
JobQuery withException()Only select jobs that failed due to an exception. -
exceptionMessage
Only select jobs that failed due to an exception with the given message. -
failedActivityId
Only select jobs that failed due to an exception at an activity with the given id. -
noRetriesLeft
JobQuery noRetriesLeft()Only select jobs which have no retries left -
active
JobQuery active()Only select jobs that are not suspended. -
suspended
JobQuery suspended()Only select jobs that are suspended. -
tenantIdIn
Only select jobs that belong to one of the given tenant ids. -
withoutTenantId
JobQuery withoutTenantId()Only select jobs which have no tenant id. -
includeJobsWithoutTenantId
JobQuery includeJobsWithoutTenantId()Select jobs which have no tenant id. Can be used in combination withtenantIdIn(String...)
. -
orderByJobId
JobQuery orderByJobId()Order by job id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByJobDuedate
JobQuery orderByJobDuedate()Order by duedate (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByJobRetries
JobQuery orderByJobRetries()Order by retries (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByJobPriority
JobQuery orderByJobPriority()Order by priority for execution (needs to be followed byQuery.asc()
orQuery.desc()
).- Since:
- 7.4
-
orderByProcessInstanceId
JobQuery orderByProcessInstanceId()Order by process instance id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionId
JobQuery orderByProcessDefinitionId()Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionKey
JobQuery orderByProcessDefinitionKey()Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByExecutionId
JobQuery orderByExecutionId()Order by execution id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTenantId
JobQuery orderByTenantId()Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). Note that the ordering of job without tenant id is database-specific.
-