Package org.flowable.job.api
Interface BaseJobQuery<U extends BaseJobQuery<U,T>,T extends Job>
-
- All Superinterfaces:
org.flowable.common.engine.api.query.Query<U,T>
- All Known Subinterfaces:
DeadLetterJobQuery
,ExternalWorkerJobQuery
,JobQuery
,SuspendedJobQuery
,TimerJobQuery
public interface BaseJobQuery<U extends BaseJobQuery<U,T>,T extends Job> extends org.flowable.common.engine.api.query.Query<U,T>
Allows programmatic querying ofJob
s. Summarizes the base query params for all JobQuery classes exceptHistoryJobQuery
- Author:
- Christopher Welsch
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description U
caseDefinitionId(String caseDefinitionId)
Only select jobs for the given case definition.U
caseInstanceId(String caseInstanceId)
Only select jobs for the given case instance.U
category(String category)
Only select jobs which exist for the given categoryU
categoryLike(String categoryLike)
Only select jobs like for the given category valueU
correlationId(String correlationId)
Only select jobs with the given correlationId.U
duedateHigherThan(Date date)
Only select jobs where the duedate is higher then the given date.U
duedateLowerThan(Date date)
Only select jobs where the duedate is lower than the given date.U
elementId(String elementId)
Only select jobs which exist for the given element idU
elementName(String elementName)
Only select jobs which exist for the given element nameU
exceptionMessage(String exceptionMessage)
Only select jobs that failed due to an exception with the given message.U
executionId(String executionId)
Only select jobs which exist for the given executionU
handlerType(String handlerType)
Select jobs which have given job handler typeU
handlerTypes(Collection<String> handlerTypes)
Select jobs which have one of the given job handler typeU
jobId(String jobId)
Only select jobs with the given idU
jobIds(Collection<String> jobIds)
Only select jobs with the given ids.U
jobTenantId(String tenantId)
Only select jobs that have the given tenant id.U
jobTenantIdLike(String tenantIdLike)
Only select jobs with a tenant id like the given one.U
jobWithoutTenantId()
Only select jobs that do not have a tenant id.U
orderByExecutionId()
Order by execution id (needs to be followed byQuery.asc()
orQuery.desc()
).U
orderByJobCreateTime()
Order by create time (needs to be followed byQuery.asc()
orQuery.desc()
).U
orderByJobDuedate()
Order by duedate (needs to be followed byQuery.asc()
orQuery.desc()
).U
orderByJobId()
Order by job id (needs to be followed byQuery.asc()
orQuery.desc()
).U
orderByJobRetries()
Order by retries (needs to be followed byQuery.asc()
orQuery.desc()
).U
orderByProcessInstanceId()
Order by process instance id (needs to be followed byQuery.asc()
orQuery.desc()
).U
orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).U
planItemInstanceId(String planItemInstanceId)
Only select jobs for the given plan item instance.U
processDefinitionId(String processDefinitionId)
Only select jobs which exist for the given process definition idU
processInstanceId(String processInstanceId)
Only select jobs which exist for the given process instance.U
scopeDefinitionId(String scopeDefinitionId)
Only select tasks for the given scope definition identifier.U
scopeId(String scopeId)
Only select tasks for the given scope identifier.U
scopeType(String scopeType)
Only select tasks for the given scope type.U
subScopeId(String subScopeId)
Only select tasks for the given sub scope identifier.U
withException()
Only select jobs that failed due to an exception.U
withoutProcessInstanceId()
Only select jobs without a process instance id value.U
withoutScopeId()
Only select jobs without a scope id value.U
withoutScopeType()
Only return jobs that do not have a scope type.
-
-
-
Method Detail
-
jobIds
U jobIds(Collection<String> jobIds)
Only select jobs with the given ids. If you use jobId(String
jobId) this filter gets ignored.
-
processInstanceId
U processInstanceId(String processInstanceId)
Only select jobs which exist for the given process instance.
-
withoutProcessInstanceId
U withoutProcessInstanceId()
Only select jobs without a process instance id value.
-
handlerTypes
U handlerTypes(Collection<String> handlerTypes)
Select jobs which have one of the given job handler type
-
processDefinitionId
U processDefinitionId(String processDefinitionId)
Only select jobs which exist for the given process definition id
-
categoryLike
U categoryLike(String categoryLike)
Only select jobs like for the given category value
-
elementName
U elementName(String elementName)
Only select jobs which exist for the given element name
-
withoutScopeId
U withoutScopeId()
Only select jobs without a scope id value.
-
withoutScopeType
U withoutScopeType()
Only return jobs that do not have a scope type.
-
scopeDefinitionId
U scopeDefinitionId(String scopeDefinitionId)
Only select tasks for the given scope definition identifier.
-
caseInstanceId
U caseInstanceId(String caseInstanceId)
Only select jobs for the given case instance.
-
caseDefinitionId
U caseDefinitionId(String caseDefinitionId)
Only select jobs for the given case definition.
-
planItemInstanceId
U planItemInstanceId(String planItemInstanceId)
Only select jobs for the given plan item instance.
-
duedateLowerThan
U duedateLowerThan(Date date)
Only select jobs where the duedate is lower than the given date.
-
duedateHigherThan
U duedateHigherThan(Date date)
Only select jobs where the duedate is higher then the given date.
-
withException
U withException()
Only select jobs that failed due to an exception.
-
exceptionMessage
U exceptionMessage(String exceptionMessage)
Only select jobs that failed due to an exception with the given message.
-
jobTenantIdLike
U jobTenantIdLike(String tenantIdLike)
Only select jobs with a tenant id like the given one.
-
jobWithoutTenantId
U jobWithoutTenantId()
Only select jobs that do not have a tenant id.
-
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()
).
-
-