JobQuery (camunda BPM Javadocs 7.8.0-SNAPSHOT)

All Superinterfaces:

Query<JobQuery,Job>

All Known Implementing Classes:

JobQueryImpl
```
public interface JobQuery
extends Query<JobQuery,Job>
```
Allows programmatic querying of Jobs.

Author:

Joram Barrez, Falko Menge

Method Summary

Methods
Modifier and Type	Method and Description
`JobQuery`	`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`	`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 execution
`JobQuery`	`includeJobsWithoutTenantId()` Select jobs which have no tenant id.
`JobQuery`	`jobDefinitionId(String jobDefinitionId)` Only select jobs which exist for the given job definition id.
`JobQuery`	`jobId(String jobId)` Only select jobs with the given id
`JobQuery`	`messages()` Only select jobs that are messages.
`JobQuery`	`noRetriesLeft()` Only select jobs which have no retries left
`JobQuery`	`orderByExecutionId()` Order by execution id (needs to be followed by `Query.asc()` or `Query.desc()`).
`JobQuery`	`orderByJobDuedate()` Order by duedate (needs to be followed by `Query.asc()` or `Query.desc()`).
`JobQuery`	`orderByJobId()` Order by job id (needs to be followed by `Query.asc()` or `Query.desc()`).
`JobQuery`	`orderByJobPriority()` Order by priority for execution (needs to be followed by `Query.asc()` or `Query.desc()`).
`JobQuery`	`orderByJobRetries()` Order by retries (needs to be followed by `Query.asc()` or `Query.desc()`).
`JobQuery`	`orderByProcessDefinitionId()` Order by process definition id (needs to be followed by `Query.asc()` or `Query.desc()`).
`JobQuery`	`orderByProcessDefinitionKey()` Order by process definition key (needs to be followed by `Query.asc()` or `Query.desc()`).
`JobQuery`	`orderByProcessInstanceId()` Order by process instance id (needs to be followed by `Query.asc()` or `Query.desc()`).
`JobQuery`	`orderByTenantId()` Order by tenant id (needs to be followed by `Query.asc()` or `Query.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`	`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

Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult

- Method Detail
  - jobId
```
JobQuery jobId(String jobId)
```
    Only select jobs with the given id
  - jobDefinitionId
```
JobQuery jobDefinitionId(String jobDefinitionId)
```
    Only select jobs which exist for the given job definition id.
  - processInstanceId
```
JobQuery processInstanceId(String processInstanceId)
```
    Only select jobs which exist for the given process instance.
  - processDefinitionId
```
JobQuery processDefinitionId(String processDefinitionId)
```
    Only select jobs which exist for the given process definition id.
  - processDefinitionKey
```
JobQuery processDefinitionKey(String processDefinitionKey)
```
    Only select jobs which exist for the given process definition key.
  - executionId
```
JobQuery executionId(String executionId)
```
    Only select jobs which exist for the given execution
  - activityId
```
JobQuery activityId(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 with messages()
  - messages
```
JobQuery messages()
```
    Only select jobs that are messages. Cannot be used together with timers()
  - duedateLowerThan
```
JobQuery duedateLowerThan(Date date)
```
    Only select jobs where the duedate is lower than the given date.
  - duedateHigherThan
```
JobQuery duedateHigherThan(Date date)
```
    Only select jobs where the duedate is higher then the given date.
  - duedateLowerThen
```
@Deprecated
JobQuery duedateLowerThen(Date date)
```
    Deprecated.
    
    Only select jobs where the duedate is lower then the given date.
  - duedateLowerThenOrEquals
```
@Deprecated
JobQuery duedateLowerThenOrEquals(Date date)
```
    Deprecated.
    
    Only select jobs where the duedate is lower then or equals the given date.
  - duedateHigherThen
```
@Deprecated
JobQuery duedateHigherThen(Date date)
```
    Deprecated.
    
    Only select jobs where the duedate is higher then the given date.
  - duedateHigherThenOrEquals
```
@Deprecated
JobQuery duedateHigherThenOrEquals(Date date)
```
    Deprecated.
    
    Only select jobs where the duedate is higher then or equals 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(String exceptionMessage)
```
    Only select jobs that failed due to an exception with the given message.
  - 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(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 with tenantIdIn(String...).
  - orderByJobId
```
JobQuery orderByJobId()
```
    Order by job id (needs to be followed by Query.asc() or Query.desc()).
  - orderByJobDuedate
```
JobQuery orderByJobDuedate()
```
    Order by duedate (needs to be followed by Query.asc() or Query.desc()).
  - orderByJobRetries
```
JobQuery orderByJobRetries()
```
    Order by retries (needs to be followed by Query.asc() or Query.desc()).
  - orderByJobPriority
```
JobQuery orderByJobPriority()
```
    Order by priority for execution (needs to be followed by Query.asc() or Query.desc()).
    
    Since:
    
    7.4
  - orderByProcessInstanceId
```
JobQuery orderByProcessInstanceId()
```
    Order by process instance id (needs to be followed by Query.asc() or Query.desc()).
  - orderByProcessDefinitionId
```
JobQuery orderByProcessDefinitionId()
```
    Order by process definition id (needs to be followed by Query.asc() or Query.desc()).
  - orderByProcessDefinitionKey
```
JobQuery orderByProcessDefinitionKey()
```
    Order by process definition key (needs to be followed by Query.asc() or Query.desc()).
  - orderByExecutionId
```
JobQuery orderByExecutionId()
```
    Order by execution id (needs to be followed by Query.asc() or Query.desc()).
  - orderByTenantId
```
JobQuery orderByTenantId()
```
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of job without tenant id is database-specific.

Interface JobQuery

Method Summary

Methods inherited from interface org.camunda.bpm.engine.query.Query

Method Detail

jobId

jobDefinitionId

processInstanceId

processDefinitionId

processDefinitionKey

executionId

activityId

withRetriesLeft

executable

timers

messages

duedateLowerThan

duedateHigherThan

duedateLowerThen

duedateLowerThenOrEquals

duedateHigherThen

duedateHigherThenOrEquals

priorityHigherThanOrEquals

priorityLowerThanOrEquals

withException

exceptionMessage

noRetriesLeft

active

suspended

tenantIdIn

withoutTenantId

includeJobsWithoutTenantId

orderByJobId

orderByJobDuedate

orderByJobRetries

orderByJobPriority

orderByProcessInstanceId

orderByProcessDefinitionId

orderByProcessDefinitionKey

orderByExecutionId

orderByTenantId