Interface BaseJobQuery<U extends BaseJobQuery<U,T> , T extends Job>
- All Superinterfaces:
Query<U,T>
- All Known Subinterfaces:
DeadLetterJobQuery, ExternalWorkerJobQuery, JobQuery, SuspendedJobQuery, TimerJobQuery
- All Known Implementing Classes:
DeadLetterJobQueryImpl, ExternalWorkerJobQueryImpl, JobQueryImpl, SuspendedJobQueryImpl, TimerJobQueryImpl
Allows programmatic querying of
Jobs.
Summarizes the base query params for all JobQuery classes except HistoryJobQuery- Author:
- Christopher Welsch
-
Nested Class Summary
Nested classes/interfaces inherited from interface Query
Query.NullHandlingOnOrder -
Method Summary
Modifier and TypeMethodDescriptioncaseDefinitionId(String caseDefinitionId) Only select jobs for the given case definition.caseDefinitionKey(String caseDefinitionKey) Only select tasks for the given case definition key.caseInstanceId(String caseInstanceId) Only select jobs for the given case instance.Only select jobs which exist for the given categorycategoryLike(String categoryLike) Only select jobs like for the given category valuecorrelationId(String correlationId) Only select jobs with the given correlationId.duedateHigherThan(Date date) Only select jobs where the duedate is higher then the given date.duedateLowerThan(Date date) Only select jobs where the duedate is lower than the given date.Only select jobs which exist for the given element idelementName(String elementName) Only select jobs which exist for the given element nameendOr()End an OR statement.exceptionMessage(String exceptionMessage) Only select jobs that failed due to an exception with the given message.executionId(String executionId) Only select jobs which exist for the given executionhandlerType(String handlerType) Select jobs which have given job handler typehandlerTypes(Collection<String> handlerTypes) Select jobs which have one of the given job handler typeOnly select jobs with the given idjobIds(Collection<String> jobIds) Only select jobs with the given ids.jobTenantId(String tenantId) Only select jobs that have the given tenant id.jobTenantIdLike(String tenantIdLike) Only select jobs with a tenant id like the given one.Only select jobs that do not have a tenant id.or()Begin an OR statement.Order by execution id (needs to be followed byQuery.asc()orQuery.desc()).Order by create time (needs to be followed byQuery.asc()orQuery.desc()).Order by duedate (needs to be followed byQuery.asc()orQuery.desc()).Order by job id (needs to be followed byQuery.asc()orQuery.desc()).Order by retries (needs to be followed byQuery.asc()orQuery.desc()).Order by process instance id (needs to be followed byQuery.asc()orQuery.desc()).Order by tenant id (needs to be followed byQuery.asc()orQuery.desc()).planItemInstanceId(String planItemInstanceId) Only select jobs for the given plan item instance.processDefinitionId(String processDefinitionId) Only select jobs which exist for the given process definition idprocessDefinitionKey(String processDefinitionKey) Only select jobs which exist for the given process definition keyprocessInstanceId(String processInstanceId) Only select jobs which exist for the given process instance.scopeDefinitionId(String scopeDefinitionId) Only select tasks for the given scope definition identifier.Only select tasks for the given scope identifier.Only select tasks for the given scope type.subScopeId(String subScopeId) Only select tasks for the given sub scope identifier.Only select jobs that failed due to an exception.Only select jobs without a process instance id value.Only select jobs without a scope id value.Only return jobs that do not have a scope type.
-
Method Details
-
jobId
-
jobIds
Only select jobs with the given ids. If you use jobId(StringjobId) this filter gets ignored. -
processInstanceId
-
withoutProcessInstanceId
U withoutProcessInstanceId()Only select jobs without a process instance id value. -
executionId
-
handlerType
-
handlerTypes
Select jobs which have one of the given job handler type -
processDefinitionId
-
processDefinitionKey
-
category
-
categoryLike
-
elementId
-
elementName
-
scopeId
-
withoutScopeId
U withoutScopeId()Only select jobs without a scope id value. -
subScopeId
-
scopeType
-
withoutScopeType
U withoutScopeType()Only return jobs that do not have a scope type. -
scopeDefinitionId
-
caseDefinitionKey
-
caseInstanceId
-
caseDefinitionId
-
planItemInstanceId
-
correlationId
-
duedateLowerThan
-
duedateHigherThan
-
withException
U withException()Only select jobs that failed due to an exception. -
exceptionMessage
-
jobTenantId
-
jobTenantIdLike
-
jobWithoutTenantId
U jobWithoutTenantId()Only select jobs that do not have a tenant id. -
or
U or()Begin an OR statement. Make sure you invoke the endOr method at the end of your OR statement. -
endOr
U endOr()End an OR statement. -
orderByJobId
U orderByJobId()Order by job id (needs to be followed byQuery.asc()orQuery.desc()). -
orderByJobDuedate
U orderByJobDuedate()Order by duedate (needs to be followed byQuery.asc()orQuery.desc()). -
orderByJobCreateTime
U orderByJobCreateTime()Order by create time (needs to be followed byQuery.asc()orQuery.desc()). -
orderByJobRetries
U orderByJobRetries()Order by retries (needs to be followed byQuery.asc()orQuery.desc()). -
orderByProcessInstanceId
U orderByProcessInstanceId()Order by process instance id (needs to be followed byQuery.asc()orQuery.desc()). -
orderByExecutionId
U orderByExecutionId()Order by execution id (needs to be followed byQuery.asc()orQuery.desc()). -
orderByTenantId
U orderByTenantId()Order by tenant id (needs to be followed byQuery.asc()orQuery.desc()).
-