ExternalWorkerJobQuery (Flowable - Job Service API 6.6.0 API)

All Superinterfaces:

Query<ExternalWorkerJobQuery,ExternalWorkerJob>
```
public interface ExternalWorkerJobQuery
extends Query<ExternalWorkerJobQuery,ExternalWorkerJob>
```
Allows programmatic querying of External Worker Jobs.

Author:

Filip Hrisafov

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
`ExternalWorkerJobQuery`	`caseDefinitionId(String caseDefinitionId)` Only select jobs for the given case definition.
`ExternalWorkerJobQuery`	`caseInstanceId(String caseInstanceId)` Only select jobs for the given case instance.
`ExternalWorkerJobQuery`	`category(String category)` Only select jobs which exist for the given category
`ExternalWorkerJobQuery`	`categoryLike(String categoryLike)` Only select jobs like for the given category value
`ExternalWorkerJobQuery`	`correlationId(String correlationId)` Only select jobs with the given correlationId.
`ExternalWorkerJobQuery`	`duedateHigherThan(Date date)` Only select jobs where the duedate is higher then the given date.
`ExternalWorkerJobQuery`	`duedateLowerThan(Date date)` Only select jobs where the duedate is lower than the given date.
`ExternalWorkerJobQuery`	`elementId(String elementId)` Only select jobs which exist for the given element id
`ExternalWorkerJobQuery`	`elementName(String elementName)` Only select jobs which exist for the given element name
`ExternalWorkerJobQuery`	`exceptionMessage(String exceptionMessage)` Only select jobs that failed due to an exception with the given message.
`ExternalWorkerJobQuery`	`executionId(String executionId)` Only select jobs which exist for the given execution
`ExternalWorkerJobQuery`	`forUserOrGroups(String userId, Collection<String> groups)` Only select jobs for the given user or groups.
`ExternalWorkerJobQuery`	`handlerType(String handlerType)` Select jobs which have given job handler type
`ExternalWorkerJobQuery`	`jobId(String jobId)` Only select jobs with the given id
`ExternalWorkerJobQuery`	`jobTenantId(String tenantId)` Only select jobs that have the given tenant id.
`ExternalWorkerJobQuery`	`jobTenantIdLike(String tenantIdLike)` Only select jobs with a tenant id like the given one.
`ExternalWorkerJobQuery`	`jobWithoutTenantId()` Only select jobs that do not have a tenant id.
`ExternalWorkerJobQuery`	`locked()` Only return jobs that are locked (i.e.
`ExternalWorkerJobQuery`	`lockOwner(String lockOwner)` Only return jobs with the given lock owner.
`ExternalWorkerJobQuery`	`orderByExecutionId()` Order by execution id (needs to be followed by `Query.asc()` or `Query.desc()`).
`ExternalWorkerJobQuery`	`orderByJobDuedate()` Order by duedate (needs to be followed by `Query.asc()` or `Query.desc()`).
`ExternalWorkerJobQuery`	`orderByJobId()` Order by job id (needs to be followed by `Query.asc()` or `Query.desc()`).
`ExternalWorkerJobQuery`	`orderByJobRetries()` Order by retries (needs to be followed by `Query.asc()` or `Query.desc()`).
`ExternalWorkerJobQuery`	`orderByProcessInstanceId()` Order by process instance id (needs to be followed by `Query.asc()` or `Query.desc()`).
`ExternalWorkerJobQuery`	`orderByTenantId()` Order by tenant id (needs to be followed by `Query.asc()` or `Query.desc()`).
`ExternalWorkerJobQuery`	`planItemInstanceId(String planItemInstanceId)` Only select jobs for the given plan item instance.
`ExternalWorkerJobQuery`	`processDefinitionId(String processDefinitionId)` Only select jobs which exist for the given process definition id
`ExternalWorkerJobQuery`	`processInstanceId(String processInstanceId)` Only select jobs which exist for the given process instance.
`ExternalWorkerJobQuery`	`scopeDefinitionId(String scopeDefinitionId)` Only select tasks for the given scope definition identifier.
`ExternalWorkerJobQuery`	`scopeId(String scopeId)` Only select tasks for the given scope identifier.
`ExternalWorkerJobQuery`	`scopeType(String scopeType)` Only select tasks for the given scope type.
`ExternalWorkerJobQuery`	`subScopeId(String subScopeId)` Only select tasks for the given sub scope identifier.
`ExternalWorkerJobQuery`	`unlocked()` Only return jobs that are not locked.
`ExternalWorkerJobQuery`	`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
```
ExternalWorkerJobQuery jobId(String jobId)
```
    Only select jobs with the given id
  - processInstanceId
```
ExternalWorkerJobQuery processInstanceId(String processInstanceId)
```
    Only select jobs which exist for the given process instance.
  - executionId
```
ExternalWorkerJobQuery executionId(String executionId)
```
    Only select jobs which exist for the given execution
  - handlerType
```
ExternalWorkerJobQuery handlerType(String handlerType)
```
    Select jobs which have given job handler type
  - processDefinitionId
```
ExternalWorkerJobQuery processDefinitionId(String processDefinitionId)
```
    Only select jobs which exist for the given process definition id
  - category
```
ExternalWorkerJobQuery category(String category)
```
    Only select jobs which exist for the given category
  - categoryLike
```
ExternalWorkerJobQuery categoryLike(String categoryLike)
```
    Only select jobs like for the given category value
  - elementId
```
ExternalWorkerJobQuery elementId(String elementId)
```
    Only select jobs which exist for the given element id
  - elementName
```
ExternalWorkerJobQuery elementName(String elementName)
```
    Only select jobs which exist for the given element name
  - scopeId
```
ExternalWorkerJobQuery scopeId(String scopeId)
```
    Only select tasks for the given scope identifier.
  - subScopeId
```
ExternalWorkerJobQuery subScopeId(String subScopeId)
```
    Only select tasks for the given sub scope identifier.
  - scopeType
```
ExternalWorkerJobQuery scopeType(String scopeType)
```
    Only select tasks for the given scope type.
  - scopeDefinitionId
```
ExternalWorkerJobQuery scopeDefinitionId(String scopeDefinitionId)
```
    Only select tasks for the given scope definition identifier.
  - caseInstanceId
```
ExternalWorkerJobQuery caseInstanceId(String caseInstanceId)
```
    Only select jobs for the given case instance.
  - caseDefinitionId
```
ExternalWorkerJobQuery caseDefinitionId(String caseDefinitionId)
```
    Only select jobs for the given case definition.
  - planItemInstanceId
```
ExternalWorkerJobQuery planItemInstanceId(String planItemInstanceId)
```
    Only select jobs for the given plan item instance.
  - correlationId
```
ExternalWorkerJobQuery correlationId(String correlationId)
```
    Only select jobs with the given correlationId.
  - duedateLowerThan
```
ExternalWorkerJobQuery duedateLowerThan(Date date)
```
    Only select jobs where the duedate is lower than the given date.
  - duedateHigherThan
```
ExternalWorkerJobQuery duedateHigherThan(Date date)
```
    Only select jobs where the duedate is higher then the given date.
  - withException
```
ExternalWorkerJobQuery withException()
```
    Only select jobs that failed due to an exception.
  - exceptionMessage
```
ExternalWorkerJobQuery exceptionMessage(String exceptionMessage)
```
    Only select jobs that failed due to an exception with the given message.
  - jobTenantId
```
ExternalWorkerJobQuery jobTenantId(String tenantId)
```
    Only select jobs that have the given tenant id.
  - jobTenantIdLike
```
ExternalWorkerJobQuery jobTenantIdLike(String tenantIdLike)
```
    Only select jobs with a tenant id like the given one.
  - jobWithoutTenantId
```
ExternalWorkerJobQuery jobWithoutTenantId()
```
    Only select jobs that do not have a tenant id.
  - forUserOrGroups
```
ExternalWorkerJobQuery forUserOrGroups(String userId,
                                       Collection<String> groups)
```
    Only select jobs for the given user or groups.
  - lockOwner
```
ExternalWorkerJobQuery lockOwner(String lockOwner)
```
    Only return jobs with the given lock owner.
  - locked
```
ExternalWorkerJobQuery locked()
```
    Only return jobs that are locked (i.e. they are acquired by an executor).
  - unlocked
```
ExternalWorkerJobQuery unlocked()
```
    Only return jobs that are not locked.
  - orderByJobId
```
ExternalWorkerJobQuery orderByJobId()
```
    Order by job id (needs to be followed by Query.asc() or Query.desc()).
  - orderByJobDuedate
```
ExternalWorkerJobQuery orderByJobDuedate()
```
    Order by duedate (needs to be followed by Query.asc() or Query.desc()).
  - orderByJobRetries
```
ExternalWorkerJobQuery orderByJobRetries()
```
    Order by retries (needs to be followed by Query.asc() or Query.desc()).
  - orderByProcessInstanceId
```
ExternalWorkerJobQuery orderByProcessInstanceId()
```
    Order by process instance id (needs to be followed by Query.asc() or Query.desc()).
  - orderByExecutionId
```
ExternalWorkerJobQuery orderByExecutionId()
```
    Order by execution id (needs to be followed by Query.asc() or Query.desc()).
  - orderByTenantId
```
ExternalWorkerJobQuery orderByTenantId()
```
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()).

Interface ExternalWorkerJobQuery

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

category

categoryLike

elementId

elementName

scopeId

subScopeId

scopeType

scopeDefinitionId

caseInstanceId

caseDefinitionId

planItemInstanceId

correlationId

duedateLowerThan

duedateHigherThan

withException

exceptionMessage

jobTenantId

jobTenantIdLike

jobWithoutTenantId

forUserOrGroups

lockOwner

locked

unlocked

orderByJobId

orderByJobDuedate

orderByJobRetries

orderByProcessInstanceId

orderByExecutionId

orderByTenantId