JobQuery (Flowable - Job Service API 6.4.1 API)

All Superinterfaces:

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

Author:

Joram Barrez, Falko Menge

Nested Class Summary
- Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
  Query.NullHandlingOnOrder

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`JobQuery`	`caseDefinitionId(String caseDefinitionId)` Only select jobs for the given case definition.
`JobQuery`	`caseInstanceId(String caseInstanceId)` Only select jobs for the given case instance.
`JobQuery`	`duedateHigherThan(Date date)` Only select jobs where the duedate is higher then the given date.
`JobQuery`	`duedateLowerThan(Date date)` Only select jobs where the duedate is lower than the given date.
`JobQuery`	`exceptionMessage(String exceptionMessage)` Only select jobs that failed due to an exception with the given message.
`JobQuery`	`executionId(String executionId)` Only select jobs which exist for the given execution
`JobQuery`	`handlerType(String handlerType)` Select jobs which have given job handler type
`JobQuery`	`jobId(String jobId)` Only select jobs with the given id
`JobQuery`	`jobTenantId(String tenantId)` Only select jobs that have the given tenant id.
`JobQuery`	`jobTenantIdLike(String tenantIdLike)` Only select jobs with a tenant id like the given one.
`JobQuery`	`jobWithoutTenantId()` Only select jobs that do not have a tenant id.
`JobQuery`	`locked()` Only return jobs that are locked (i.e.
`JobQuery`	`lockOwner(String lockOwner)` Only return jobs with the given lock owner.
`JobQuery`	`messages()` Only select jobs that are messages.
`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`	`orderByJobRetries()` Order by retries (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`	`planItemInstanceId(String planItemInstanceId)` Only select jobs for the given plan item instance.
`JobQuery`	`processDefinitionId(String processDefinitionId)` Only select jobs which exist for the given process definition id
`JobQuery`	`processInstanceId(String processInstanceId)` Only select jobs which exist for the given process instance.
`JobQuery`	`scopeDefinitionId(String scopeDefinitionId)` Only select tasks for the given scope definition identifier.
`JobQuery`	`scopeId(String scopeId)` Only select tasks for the given scope identifier.
`JobQuery`	`scopeType(String scopeType)` Only select tasks for the given scope type.
`JobQuery`	`subScopeId(String subScopeId)` Only select tasks for the given sub scope identifier.
`JobQuery`	`timers()` Only select jobs that are timers.
`JobQuery`	`unlocked()` Only return jobs that are not locked.
`JobQuery`	`withException()` Only select jobs that failed due to an exception.

Methods inherited from interface org.flowable.common.engine.api.query.Query
asc, count, desc, list, listPage, orderBy, orderBy, singleResult

- Method Detail
  - jobId
```
JobQuery jobId(String jobId)
```
    Only select jobs with the given id
  - processInstanceId
```
JobQuery processInstanceId(String processInstanceId)
```
    Only select jobs which exist for the given process instance.
  - executionId
```
JobQuery executionId(String executionId)
```
    Only select jobs which exist for the given execution
  - handlerType
```
JobQuery handlerType(String handlerType)
```
    Select jobs which have given job handler type
  - processDefinitionId
```
JobQuery processDefinitionId(String processDefinitionId)
```
    Only select jobs which exist for the given process definition id
  - scopeId
```
JobQuery scopeId(String scopeId)
```
    Only select tasks for the given scope identifier.
  - subScopeId
```
JobQuery subScopeId(String subScopeId)
```
    Only select tasks for the given sub scope identifier.
  - scopeType
```
JobQuery scopeType(String scopeType)
```
    Only select tasks for the given scope type.
  - scopeDefinitionId
```
JobQuery scopeDefinitionId(String scopeDefinitionId)
```
    Only select tasks for the given scope definition identifier.
  - caseInstanceId
```
JobQuery caseInstanceId(String caseInstanceId)
```
    Only select jobs for the given case instance.
  - caseDefinitionId
```
JobQuery caseDefinitionId(String caseDefinitionId)
```
    Only select jobs for the given case definition.
  - planItemInstanceId
```
JobQuery planItemInstanceId(String planItemInstanceId)
```
    Only select jobs for the given plan item instance.
  - 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.
  - 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.
  - jobTenantId
```
JobQuery jobTenantId(String tenantId)
```
    Only select jobs that have the given tenant id.
  - jobTenantIdLike
```
JobQuery jobTenantIdLike(String tenantIdLike)
```
    Only select jobs with a tenant id like the given one.
  - jobWithoutTenantId
```
JobQuery jobWithoutTenantId()
```
    Only select jobs that do not have a tenant id.
  - lockOwner
```
JobQuery lockOwner(String lockOwner)
```
    Only return jobs with the given lock owner.
  - locked
```
JobQuery locked()
```
    Only return jobs that are locked (i.e. they are acquired by an executor).
  - unlocked
```
JobQuery unlocked()
```
    Only return jobs that are not locked.
  - 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()).
  - orderByProcessInstanceId
```
JobQuery orderByProcessInstanceId()
```
    Order by process instance id (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()).

Interface JobQuery

Nested Class Summary

Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query

Method Summary

Methods inherited from interface org.flowable.common.engine.api.query.Query

Method Detail

jobId

processInstanceId

executionId

handlerType

processDefinitionId

scopeId

subScopeId

scopeType

scopeDefinitionId

caseInstanceId

caseDefinitionId

planItemInstanceId

timers

messages

duedateLowerThan

duedateHigherThan

withException

exceptionMessage

jobTenantId

jobTenantIdLike

jobWithoutTenantId

lockOwner

locked

unlocked

orderByJobId

orderByJobDuedate

orderByJobRetries

orderByProcessInstanceId

orderByExecutionId

orderByTenantId