Package org.camunda.bpm.engine.runtime
Interface JobQuery
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description JobQuery
active()
Only select jobs that are not suspended.JobQuery
activityId(java.lang.String activityId)
Only select jobs which are defined on an activity with the given id.JobQuery
createdAfter(java.util.Date date)
Only select jobs created after the given date.JobQuery
createdBefore(java.util.Date date)
Only select jobs created before the given date.JobQuery
duedateHigherThan(java.util.Date date)
Only select jobs where the duedate is higher then the given date.JobQuery
duedateHigherThen(java.util.Date date)
Deprecated.JobQuery
duedateHigherThenOrEquals(java.util.Date date)
Deprecated.JobQuery
duedateLowerThan(java.util.Date date)
Only select jobs where the duedate is lower than the given date.JobQuery
duedateLowerThen(java.util.Date date)
Deprecated.JobQuery
duedateLowerThenOrEquals(java.util.Date date)
Deprecated.JobQuery
exceptionMessage(java.lang.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(java.lang.String executionId)
Only select jobs which exist for the given executionJobQuery
failedActivityId(java.lang.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(java.lang.String jobDefinitionId)
Only select jobs which exist for the given job definition id.JobQuery
jobId(java.lang.String jobId)
Only select jobs with the given idJobQuery
jobIds(java.util.Set<java.lang.String> ids)
Only 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(java.lang.String processDefinitionId)
Only select jobs which exist for the given process definition id.JobQuery
processDefinitionKey(java.lang.String processDefinitionKey)
Only select jobs which exist for the given process definition key.JobQuery
processInstanceId(java.lang.String processInstanceId)
Only select jobs which exist for the given process instance.JobQuery
processInstanceIds(java.util.Set<java.lang.String> processInstanceIds)
Only select jobs which exist for any of the given process instance idsJobQuery
suspended()
Only select jobs that are suspended.JobQuery
tenantIdIn(java.lang.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-
Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
-
-
-
Method Detail
-
jobId
JobQuery jobId(java.lang.String jobId)
Only select jobs with the given id
-
jobIds
JobQuery jobIds(java.util.Set<java.lang.String> ids)
Only select jobs whose id is in the given set of ids
-
jobDefinitionId
JobQuery jobDefinitionId(java.lang.String jobDefinitionId)
Only select jobs which exist for the given job definition id.
-
processInstanceId
JobQuery processInstanceId(java.lang.String processInstanceId)
Only select jobs which exist for the given process instance.
-
processInstanceIds
JobQuery processInstanceIds(java.util.Set<java.lang.String> processInstanceIds)
Only select jobs which exist for any of the given process instance ids
-
processDefinitionId
JobQuery processDefinitionId(java.lang.String processDefinitionId)
Only select jobs which exist for the given process definition id.
-
processDefinitionKey
JobQuery processDefinitionKey(java.lang.String processDefinitionKey)
Only select jobs which exist for the given process definition key.
-
executionId
JobQuery executionId(java.lang.String executionId)
Only select jobs which exist for the given execution
-
activityId
JobQuery activityId(java.lang.String 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
JobQuery duedateLowerThan(java.util.Date date)
Only select jobs where the duedate is lower than the given date.
-
duedateHigherThan
JobQuery duedateHigherThan(java.util.Date date)
Only select jobs where the duedate is higher then the given date.
-
duedateLowerThen
@Deprecated JobQuery duedateLowerThen(java.util.Date date)
Deprecated.Only select jobs where the duedate is lower then the given date.
-
duedateLowerThenOrEquals
@Deprecated JobQuery duedateLowerThenOrEquals(java.util.Date date)
Deprecated.Only select jobs where the duedate is lower then or equals the given date.
-
duedateHigherThen
@Deprecated JobQuery duedateHigherThen(java.util.Date date)
Deprecated.Only select jobs where the duedate is higher then the given date.
-
duedateHigherThenOrEquals
@Deprecated JobQuery duedateHigherThenOrEquals(java.util.Date date)
Deprecated.Only select jobs where the duedate is higher then or equals the given date.
-
createdBefore
JobQuery createdBefore(java.util.Date date)
Only select jobs created before the given date.
-
createdAfter
JobQuery createdAfter(java.util.Date date)
Only select jobs created after the given date.
-
priorityHigherThanOrEquals
JobQuery priorityHigherThanOrEquals(long priority)
Only select jobs with a priority that is higher than or equal to the given priority.- Since:
- 7.4
-
priorityLowerThanOrEquals
JobQuery priorityLowerThanOrEquals(long priority)
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
JobQuery exceptionMessage(java.lang.String exceptionMessage)
Only select jobs that failed due to an exception with the given message.
-
failedActivityId
JobQuery failedActivityId(java.lang.String activityId)
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
JobQuery tenantIdIn(java.lang.String... tenantIds)
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.
-
-