Interface JobDefinitionQuery
-
- All Superinterfaces:
Query<JobDefinitionQuery,JobDefinition>
- All Known Implementing Classes:
JobDefinitionQueryImpl
public interface JobDefinitionQuery extends Query<JobDefinitionQuery,JobDefinition>
Allows programmatic querying ofJobDefinition
s.- Author:
- roman.smirnov
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JobDefinitionQuery
active()
Only selects job definitions which are activeJobDefinitionQuery
activityIdIn(String... activityIds)
Only select job definitions which exist for the listed activity idsJobDefinitionQuery
includeJobDefinitionsWithoutTenantId()
Select job definitions which have no tenant id.JobDefinitionQuery
jobConfiguration(String jobConfiguration)
Only select job definitions which contain the configuration.JobDefinitionQuery
jobDefinitionId(String jobDefinitionId)
Only select job definitions with the given idJobDefinitionQuery
jobType(String jobType)
Only select job definitions which have the given job type.JobDefinitionQuery
orderByActivityId()
Order by activty id (needs to be followed byQuery.asc()
orQuery.desc()
).JobDefinitionQuery
orderByJobConfiguration()
Order by job configuration (needs to be followed byQuery.asc()
orQuery.desc()
).JobDefinitionQuery
orderByJobDefinitionId()
Order by id (needs to be followed byQuery.asc()
orQuery.desc()
).JobDefinitionQuery
orderByJobType()
Order by job type (needs to be followed byQuery.asc()
orQuery.desc()
).JobDefinitionQuery
orderByProcessDefinitionId()
Order by process defintion id (needs to be followed byQuery.asc()
orQuery.desc()
).JobDefinitionQuery
orderByProcessDefinitionKey()
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).JobDefinitionQuery
orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).JobDefinitionQuery
processDefinitionId(String processDefinitionId)
Only select job definitions which exist for the given process definition id.JobDefinitionQuery
processDefinitionKey(String processDefinitionKey)
Only select job definitions which exist for the given process definition key.JobDefinitionQuery
suspended()
Only selects job definitions which are suspendedJobDefinitionQuery
tenantIdIn(String... tenantIds)
Only select job definitions that belong to one of the given tenant ids.JobDefinitionQuery
withoutTenantId()
Only select job definitions which have no tenant id.JobDefinitionQuery
withOverridingJobPriority()
Only selects job definitions which have a job priority defined.-
Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
-
-
-
Method Detail
-
jobDefinitionId
JobDefinitionQuery jobDefinitionId(String jobDefinitionId)
Only select job definitions with the given id
-
activityIdIn
JobDefinitionQuery activityIdIn(String... activityIds)
Only select job definitions which exist for the listed activity ids
-
processDefinitionId
JobDefinitionQuery processDefinitionId(String processDefinitionId)
Only select job definitions which exist for the given process definition id.
-
processDefinitionKey
JobDefinitionQuery processDefinitionKey(String processDefinitionKey)
Only select job definitions which exist for the given process definition key.
-
jobType
JobDefinitionQuery jobType(String jobType)
Only select job definitions which have the given job type.
-
jobConfiguration
JobDefinitionQuery jobConfiguration(String jobConfiguration)
Only select job definitions which contain the configuration.
-
active
JobDefinitionQuery active()
Only selects job definitions which are active
-
suspended
JobDefinitionQuery suspended()
Only selects job definitions which are suspended
-
withOverridingJobPriority
JobDefinitionQuery withOverridingJobPriority()
Only selects job definitions which have a job priority defined.- Since:
- 7.4
-
tenantIdIn
JobDefinitionQuery tenantIdIn(String... tenantIds)
Only select job definitions that belong to one of the given tenant ids.
-
withoutTenantId
JobDefinitionQuery withoutTenantId()
Only select job definitions which have no tenant id.
-
includeJobDefinitionsWithoutTenantId
JobDefinitionQuery includeJobDefinitionsWithoutTenantId()
Select job definitions which have no tenant id. Can be used in combination withtenantIdIn(String...)
.
-
orderByJobDefinitionId
JobDefinitionQuery orderByJobDefinitionId()
Order by id (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByActivityId
JobDefinitionQuery orderByActivityId()
Order by activty id (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByProcessDefinitionId
JobDefinitionQuery orderByProcessDefinitionId()
Order by process defintion id (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByProcessDefinitionKey
JobDefinitionQuery orderByProcessDefinitionKey()
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByJobType
JobDefinitionQuery orderByJobType()
Order by job type (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByJobConfiguration
JobDefinitionQuery orderByJobConfiguration()
Order by job configuration (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByTenantId
JobDefinitionQuery orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). Note that the ordering of job definitions without tenant id is database-specific.
-
-