Package org.flowable.job.service.impl

Class HistoryJobQueryImpl

java.lang.Object

org.flowable.common.engine.impl.db.ListQueryParameterObject

org.flowable.common.engine.impl.query.AbstractQuery<HistoryJobQuery,HistoryJob>

org.flowable.job.service.impl.HistoryJobQueryImpl

All Implemented Interfaces:

Serializable, Query<HistoryJobQuery,HistoryJob>, Command<Object>, HistoryJobQuery

public class HistoryJobQueryImpl
extends AbstractQuery<HistoryJobQuery,HistoryJob>
implements HistoryJobQuery, Serializable

Author:

Joram Barrez, Tom Baeyens, Falko Menge

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType

Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query

Query.NullHandlingOnOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	exceptionMessage
protected String	handlerType
protected Collection<String>	handlerTypes
protected String	id
protected JobServiceConfiguration	jobServiceConfiguration
protected String	lockOwner
protected boolean	onlyLocked
protected boolean	onlyUnlocked
protected String	scopeType
protected String	tenantId
protected String	tenantIdLike
protected boolean	withException
protected boolean	withoutScopeType
protected boolean	withoutTenantId

Fields inherited from class org.flowable.common.engine.impl.query.AbstractQuery

commandContext, commandExecutor

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

databaseType, DEFAULT_ORDER_BY, defaultOrderBy, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors

Constructor	Description
HistoryJobQueryImpl()
HistoryJobQueryImpl(CommandContext commandContext, JobServiceConfiguration jobServiceConfiguration)
HistoryJobQueryImpl(CommandExecutor commandExecutor, JobServiceConfiguration jobServiceConfiguration)

Method Summary

Modifier and Type	Method	Description
HistoryJobQuery	exceptionMessage(String exceptionMessage)	Only select jobs that failed due to an exception with the given message.
long	executeCount(CommandContext commandContext)
List<HistoryJob>	executeList(CommandContext commandContext)	Executes the actual query to retrieve the list of results.
String	getExceptionMessage()
String	getHandlerType()
Collection<String>	getHandlerTypes()
String	getId()
String	getLockOwner()
Date	getNow()
String	getScopeType()
static long	getSerialversionuid()
String	getTenantId()
String	getTenantIdLike()
HistoryJobQuery	handlerType(String handlerType)	Select jobs which have given job handler type
HistoryJobQuery	handlerTypes(Collection<String> handlerTypes)	Select jobs which have given job handler type
boolean	isOnlyLocked()
boolean	isOnlyUnlocked()
boolean	isWithException()
boolean	isWithoutScopeType()
boolean	isWithoutTenantId()
HistoryJobQuery	jobId(String jobId)	Only select jobs with the given id
HistoryJobQuery	jobTenantId(String tenantId)	Only select jobs that have the given tenant id.
HistoryJobQuery	jobTenantIdLike(String tenantIdLike)	Only select jobs with a tenant id like the given one.
HistoryJobQuery	jobWithoutTenantId()	Only select jobs that do not have a tenant id.
HistoryJobQuery	locked()	Only return jobs that are locked (i.e.
HistoryJobQuery	lockOwner(String lockOwner)	Only return jobs with the given lock owner.
HistoryJobQuery	orderByJobId()	Order by job id (needs to be followed by Query.asc() or Query.desc()).
HistoryJobQuery	orderByJobRetries()	Order by retries (needs to be followed by Query.asc() or Query.desc()).
HistoryJobQuery	orderByTenantId()	Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
HistoryJobQuery	scopeType(String scopeType)	Only select jobs with the given scope type.
HistoryJobQuery	unlocked()	Only return jobs that are not locked.
HistoryJobQuery	withException()	Only select jobs that failed due to an exception.
HistoryJobQuery	withoutScopeType()	Only return jobs that do not have a scope type.

Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery

asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, list, listPage, orderBy, orderBy, setCommandExecutor, singleResult

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

addOrder, buildOrderBy, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getNullHandlingColumn, getOrderBy, getOrderByCollectionSafe, getOrderByForWindow, getOuterJoinOrderBy, getParameter, hasOrderBy, hasOrderByForColumn, isNeedsPaging, mapOrderByToSql, setDatabaseType, setFirstResult, setMaxResults, setNullHandlingColumn, setParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.flowable.common.engine.api.query.Query

asc, count, desc, list, listPage, orderBy, orderBy, singleResult

Field Details

jobServiceConfiguration

protected JobServiceConfiguration jobServiceConfiguration

id

protected String id

handlerType

protected String handlerType

handlerTypes

protected Collection<String> handlerTypes

withException

protected boolean withException

exceptionMessage

protected String exceptionMessage

scopeType

protected String scopeType

tenantId

protected String tenantId

tenantIdLike

protected String tenantIdLike

withoutTenantId

protected boolean withoutTenantId

lockOwner

protected String lockOwner

onlyLocked

protected boolean onlyLocked

onlyUnlocked

protected boolean onlyUnlocked

withoutScopeType

protected boolean withoutScopeType

Constructor Details

HistoryJobQueryImpl

public HistoryJobQueryImpl()

HistoryJobQueryImpl

public HistoryJobQueryImpl(CommandContext commandContext,
 JobServiceConfiguration jobServiceConfiguration)

HistoryJobQueryImpl

public HistoryJobQueryImpl(CommandExecutor commandExecutor,
 JobServiceConfiguration jobServiceConfiguration)

Method Details

jobId

public HistoryJobQuery jobId(String jobId)

Description copied from interface: HistoryJobQuery

Only select jobs with the given id

Specified by:

jobId in interface HistoryJobQuery

handlerType

public HistoryJobQuery handlerType(String handlerType)

Description copied from interface: HistoryJobQuery

Select jobs which have given job handler type

Specified by:

handlerType in interface HistoryJobQuery

handlerTypes

public HistoryJobQuery handlerTypes(Collection<String> handlerTypes)

Description copied from interface: HistoryJobQuery

Select jobs which have given job handler type

Specified by:

handlerTypes in interface HistoryJobQuery

withException

public HistoryJobQuery withException()

Description copied from interface: HistoryJobQuery

Only select jobs that failed due to an exception.

Specified by:

withException in interface HistoryJobQuery

exceptionMessage

public HistoryJobQuery exceptionMessage(String exceptionMessage)

Description copied from interface: HistoryJobQuery

Only select jobs that failed due to an exception with the given message.

Specified by:

exceptionMessage in interface HistoryJobQuery

scopeType

public HistoryJobQuery scopeType(String scopeType)

Description copied from interface: HistoryJobQuery

Only select jobs with the given scope type.

Specified by:

scopeType in interface HistoryJobQuery

jobTenantId

public HistoryJobQuery jobTenantId(String tenantId)

Description copied from interface: HistoryJobQuery

Only select jobs that have the given tenant id.

Specified by:

jobTenantId in interface HistoryJobQuery

jobTenantIdLike

public HistoryJobQuery jobTenantIdLike(String tenantIdLike)

Description copied from interface: HistoryJobQuery

Only select jobs with a tenant id like the given one.

Specified by:

jobTenantIdLike in interface HistoryJobQuery

jobWithoutTenantId

public HistoryJobQuery jobWithoutTenantId()

Description copied from interface: HistoryJobQuery

Only select jobs that do not have a tenant id.

Specified by:

jobWithoutTenantId in interface HistoryJobQuery

lockOwner

public HistoryJobQuery lockOwner(String lockOwner)

Description copied from interface: HistoryJobQuery

Only return jobs with the given lock owner.

Specified by:

lockOwner in interface HistoryJobQuery

locked

public HistoryJobQuery locked()

Description copied from interface: HistoryJobQuery

Only return jobs that are locked (i.e. they are acquired by an executor).

Specified by:

locked in interface HistoryJobQuery

unlocked

public HistoryJobQuery unlocked()

Description copied from interface: HistoryJobQuery

Only return jobs that are not locked.

Specified by:

unlocked in interface HistoryJobQuery

withoutScopeType

public HistoryJobQuery withoutScopeType()

Description copied from interface: HistoryJobQuery

Only return jobs that do not have a scope type.

Specified by:

withoutScopeType in interface HistoryJobQuery

orderByJobId

public HistoryJobQuery orderByJobId()

Description copied from interface: HistoryJobQuery

Order by job id (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByJobId in interface HistoryJobQuery

orderByJobRetries

public HistoryJobQuery orderByJobRetries()

Description copied from interface: HistoryJobQuery

Order by retries (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByJobRetries in interface HistoryJobQuery

orderByTenantId

public HistoryJobQuery orderByTenantId()

Description copied from interface: HistoryJobQuery

Order by tenant id (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByTenantId in interface HistoryJobQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<HistoryJobQuery,HistoryJob>

executeList

public List<HistoryJob> executeList(CommandContext commandContext)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<HistoryJobQuery,HistoryJob>

getHandlerType

public String getHandlerType()

getHandlerTypes

public Collection<String> getHandlerTypes()

getNow

public Date getNow()

isWithException

public boolean isWithException()

getExceptionMessage

public String getExceptionMessage()

getScopeType

public String getScopeType()

getTenantId

public String getTenantId()

getTenantIdLike

public String getTenantIdLike()

isWithoutTenantId

public boolean isWithoutTenantId()

getSerialversionuid

public static long getSerialversionuid()

getId

public String getId()

getLockOwner

public String getLockOwner()

isOnlyLocked

public boolean isOnlyLocked()

isOnlyUnlocked

public boolean isOnlyUnlocked()

isWithoutScopeType

public boolean isWithoutScopeType()