Package org.flowable.job.api
Interface HistoryJobQuery
- All Superinterfaces:
org.flowable.common.engine.api.query.Query<HistoryJobQuery,
HistoryJob>
public interface HistoryJobQuery
extends org.flowable.common.engine.api.query.Query<HistoryJobQuery,HistoryJob>
Allows programmatic querying of
HistoryJob
s.- Author:
- Joram Barrez, Tijs Rademakers
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
org.flowable.common.engine.api.query.Query.NullHandlingOnOrder
-
Method Summary
Modifier and TypeMethodDescriptionexceptionMessage
(String exceptionMessage) Only select jobs that failed due to an exception with the given message.handlerType
(String handlerType) Select jobs which have given job handler typehandlerTypes
(Collection<String> handlerType) Select jobs which have given job handler typeOnly select jobs with the given idjobTenantId
(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.locked()
Only return jobs that are locked (i.e. they are acquired by an executor).Only return jobs with the given lock owner.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 tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).Only select jobs with the given scope type.unlocked()
Only return jobs that are not locked.Only select jobs that failed due to an exception.Only return jobs that do not have a scope type.Methods inherited from interface org.flowable.common.engine.api.query.Query
asc, count, desc, list, listPage, orderBy, orderBy, singleResult
-
Method Details
-
jobId
Only select jobs with the given id -
handlerType
Select jobs which have given job handler type -
handlerTypes
Select jobs which have given job handler type -
withException
HistoryJobQuery withException()Only select jobs that failed due to an exception. -
exceptionMessage
Only select jobs that failed due to an exception with the given message. -
scopeType
Only select jobs with the given scope type. -
withoutScopeType
HistoryJobQuery withoutScopeType()Only return jobs that do not have a scope type. -
jobTenantId
Only select jobs that have the given tenant id. -
jobTenantIdLike
Only select jobs with a tenant id like the given one. -
jobWithoutTenantId
HistoryJobQuery jobWithoutTenantId()Only select jobs that do not have a tenant id. -
lockOwner
Only return jobs with the given lock owner. -
locked
HistoryJobQuery locked()Only return jobs that are locked (i.e. they are acquired by an executor). -
unlocked
HistoryJobQuery unlocked()Only return jobs that are not locked. -
orderByJobId
HistoryJobQuery orderByJobId()Order by job id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByJobRetries
HistoryJobQuery orderByJobRetries()Order by retries (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTenantId
HistoryJobQuery orderByTenantId()Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).
-