Class TimerJobQueryImpl

java.lang.Object

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

org.flowable.common.engine.impl.query.AbstractQuery<TimerJobQuery, Job>

org.flowable.job.service.impl.TimerJobQueryImpl

All Implemented Interfaces:

Serializable, Query<TimerJobQuery, Job>, Command<Object>, BaseJobQuery<TimerJobQuery, Job>, TimerJobQuery

public class TimerJobQueryImpl
extends AbstractQuery<TimerJobQuery, Job>
implements TimerJobQuery, Serializable

Author:

Joram Barrez, Tijs Rademakers

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ListQueryParameterObject

ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType

Nested classes/interfaces inherited from interface Query

Query.NullHandlingOnOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	caseDefinitionKey
protected String	category
protected String	categoryLike
protected String	correlationId
protected TimerJobQueryImpl	currentOrQueryObject
protected Date	duedateHigherThan
protected Date	duedateHigherThanOrEqual
protected Date	duedateLowerThan
protected Date	duedateLowerThanOrEqual
protected String	elementId
protected String	elementName
protected String	exceptionMessage
protected boolean	executable
protected String	executionId
protected String	handlerType
protected Collection<String>	handlerTypes
protected String	id
protected boolean	inOrStatement
protected Collection<String>	jobIds
protected JobServiceConfiguration	jobServiceConfiguration
protected boolean	onlyMessages
protected boolean	onlyTimers
protected List<TimerJobQueryImpl>	orQueryObjects
protected String	processDefinitionId
protected String	processDefinitionKey
protected String	processInstanceId
protected String	scopeDefinitionId
protected String	scopeId
protected String	scopeType
protected String	subScopeId
protected String	tenantId
protected String	tenantIdLike
protected boolean	withException
protected boolean	withoutProcessInstanceId
protected boolean	withoutScopeId
protected boolean	withoutScopeType
protected boolean	withoutTenantId

Fields inherited from class AbstractQuery

commandContext, commandExecutor

Fields inherited from class ListQueryParameterObject

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TimerJobQueryImpl	caseDefinitionId(String caseDefinitionId)	Only select jobs for the given case definition.
TimerJobQueryImpl	caseDefinitionKey(String caseDefinitionKey)	Only select tasks for the given case definition key.
TimerJobQueryImpl	caseInstanceId(String caseInstanceId)	Only select jobs for the given case instance.
TimerJobQueryImpl	category(String category)	Only select jobs which exist for the given category
TimerJobQueryImpl	categoryLike(String categoryLike)	Only select jobs like for the given category value
TimerJobQueryImpl	correlationId(String correlationId)	Only select jobs with the given correlationId.
TimerJobQueryImpl	duedateHigherThan(Date date)	Only select jobs where the duedate is higher then the given date.
TimerJobQueryImpl	duedateLowerThan(Date date)	Only select jobs where the duedate is lower than the given date.
TimerJobQueryImpl	elementId(String elementId)	Only select jobs which exist for the given element id
TimerJobQueryImpl	elementName(String elementName)	Only select jobs which exist for the given element name
TimerJobQuery	endOr()	End an OR statement.
TimerJobQueryImpl	exceptionMessage(String exceptionMessage)	Only select jobs that failed due to an exception with the given message.
TimerJobQueryImpl	executable()	Only select jobs which are executable, ie. duedate is null or duedate is in the past
long	executeCount(CommandContext commandContext)
List<Job>	executeList(CommandContext commandContext)	Executes the actual query to retrieve the list of results.
TimerJobQueryImpl	executionId(String executionId)	Only select jobs which exist for the given execution
String	getCaseDefinitionKey()
String	getCategory()
String	getCategoryLike()
String	getCorrelationId()
Date	getDuedateHigherThan()
Date	getDuedateHigherThanOrEqual()
Date	getDuedateLowerThan()
Date	getDuedateLowerThanOrEqual()
String	getElementId()
String	getElementName()
String	getExceptionMessage()
boolean	getExecutable()
String	getExecutionId()
String	getHandlerType()
Collection<String>	getHandlerTypes()
String	getId()
Date	getNow()
List<TimerJobQueryImpl>	getOrQueryObjects()
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
String	getProcessInstanceId()
String	getScopeDefinitionId()
String	getScopeId()
String	getScopeType()
String	getSubScopeId()
String	getTenantId()
String	getTenantIdLike()
TimerJobQueryImpl	handlerType(String handlerType)	Select jobs which have given job handler type
TimerJobQuery	handlerTypes(Collection<String> handlerTypes)	Select jobs which have one of the given job handler type
boolean	isExecutable()
boolean	isOnlyMessages()
boolean	isOnlyTimers()
boolean	isWithException()
boolean	isWithoutProcessInstanceId()
boolean	isWithoutScopeId()
boolean	isWithoutScopeType()
boolean	isWithoutTenantId()
TimerJobQueryImpl	jobId(String jobId)	Only select jobs with the given id
TimerJobQuery	jobIds(Collection<String> jobIds)	Only select jobs with the given ids.
TimerJobQueryImpl	jobTenantId(String tenantId)	Only select jobs that have the given tenant id.
TimerJobQueryImpl	jobTenantIdLike(String tenantIdLike)	Only select jobs with a tenant id like the given one.
TimerJobQueryImpl	jobWithoutTenantId()	Only select jobs that do not have a tenant id.
TimerJobQueryImpl	messages()	Only select jobs that are messages.
TimerJobQuery	or()	Begin an OR statement.
TimerJobQuery	orderByExecutionId()	Order by execution id (needs to be followed by Query.asc() or Query.desc()).
TimerJobQuery	orderByJobCreateTime()	Order by create time (needs to be followed by Query.asc() or Query.desc()).
TimerJobQuery	orderByJobDuedate()	Order by duedate (needs to be followed by Query.asc() or Query.desc()).
TimerJobQuery	orderByJobId()	Order by job id (needs to be followed by Query.asc() or Query.desc()).
TimerJobQuery	orderByJobRetries()	Order by retries (needs to be followed by Query.asc() or Query.desc()).
TimerJobQuery	orderByProcessInstanceId()	Order by process instance id (needs to be followed by Query.asc() or Query.desc()).
TimerJobQuery	orderByTenantId()	Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
TimerJobQueryImpl	planItemInstanceId(String planItemInstanceId)	Only select jobs for the given plan item instance.
TimerJobQueryImpl	processDefinitionId(String processDefinitionId)	Only select jobs which exist for the given process definition id
TimerJobQueryImpl	processDefinitionKey(String processDefinitionKey)	Only select jobs which exist for the given process definition key
TimerJobQueryImpl	processInstanceId(String processInstanceId)	Only select jobs which exist for the given process instance.
TimerJobQueryImpl	scopeDefinitionId(String scopeDefinitionId)	Only select tasks for the given scope definition identifier.
TimerJobQueryImpl	scopeId(String scopeId)	Only select tasks for the given scope identifier.
TimerJobQueryImpl	scopeType(String scopeType)	Only select tasks for the given scope type.
TimerJobQueryImpl	subScopeId(String subScopeId)	Only select tasks for the given sub scope identifier.
TimerJobQueryImpl	timers()	Only select jobs that are timers.
TimerJobQueryImpl	withException()	Only select jobs that failed due to an exception.
TimerJobQueryImpl	withoutProcessInstanceId()	Only select jobs without a process instance id value.
TimerJobQueryImpl	withoutScopeId()	Only select jobs without a scope id value.
TimerJobQueryImpl	withoutScopeType()	Only return jobs that do not have a scope type.

Methods inherited from class AbstractQuery

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

Methods inherited from class ListQueryParameterObject

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

Methods inherited from class Object

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

Methods inherited from interface Query

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

Field Details

jobServiceConfiguration

protected JobServiceConfiguration jobServiceConfiguration

id

protected String id

jobIds

protected Collection<String> jobIds

processInstanceId

protected String processInstanceId

withoutProcessInstanceId

protected boolean withoutProcessInstanceId

executionId

protected String executionId

handlerType

protected String handlerType

handlerTypes

protected Collection<String> handlerTypes

processDefinitionId

protected String processDefinitionId

processDefinitionKey

protected String processDefinitionKey

category

protected String category

categoryLike

protected String categoryLike

elementId

protected String elementId

elementName

protected String elementName

scopeId

protected String scopeId

withoutScopeId

protected boolean withoutScopeId

subScopeId

protected String subScopeId

scopeType

protected String scopeType

withoutScopeType

protected boolean withoutScopeType

scopeDefinitionId

protected String scopeDefinitionId

caseDefinitionKey

protected String caseDefinitionKey

correlationId

protected String correlationId

executable

protected boolean executable

onlyTimers

protected boolean onlyTimers

onlyMessages

protected boolean onlyMessages

duedateHigherThan

protected Date duedateHigherThan

duedateLowerThan

protected Date duedateLowerThan

duedateHigherThanOrEqual

protected Date duedateHigherThanOrEqual

duedateLowerThanOrEqual

protected Date duedateLowerThanOrEqual

withException

protected boolean withException

exceptionMessage

protected String exceptionMessage

tenantId

protected String tenantId

tenantIdLike

protected String tenantIdLike

withoutTenantId

protected boolean withoutTenantId

orQueryObjects

protected List<TimerJobQueryImpl> orQueryObjects

currentOrQueryObject

protected TimerJobQueryImpl currentOrQueryObject

inOrStatement

protected boolean inOrStatement

Constructor Details

TimerJobQueryImpl

public TimerJobQueryImpl()

TimerJobQueryImpl

public TimerJobQueryImpl(CommandContext commandContext,
 JobServiceConfiguration jobServiceConfiguration)

TimerJobQueryImpl

public TimerJobQueryImpl(CommandExecutor commandExecutor,
 JobServiceConfiguration jobServiceConfiguration)

Method Details

jobId

public TimerJobQueryImpl jobId(String jobId)

Description copied from interface: BaseJobQuery

Only select jobs with the given id

Specified by:

jobId in interface BaseJobQuery<TimerJobQuery, Job>

jobIds

public TimerJobQuery jobIds(Collection<String> jobIds)

Description copied from interface: BaseJobQuery

Only select jobs with the given ids. If you use jobId(String jobId) this filter gets ignored.

Specified by:

jobIds in interface BaseJobQuery<TimerJobQuery, Job>

processInstanceId

public TimerJobQueryImpl processInstanceId(String processInstanceId)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given process instance.

Specified by:

processInstanceId in interface BaseJobQuery<TimerJobQuery, Job>

withoutProcessInstanceId

public TimerJobQueryImpl withoutProcessInstanceId()

Description copied from interface: BaseJobQuery

Only select jobs without a process instance id value.

Specified by:

withoutProcessInstanceId in interface BaseJobQuery<TimerJobQuery, Job>

processDefinitionId

public TimerJobQueryImpl processDefinitionId(String processDefinitionId)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given process definition id

Specified by:

processDefinitionId in interface BaseJobQuery<TimerJobQuery, Job>

processDefinitionKey

public TimerJobQueryImpl processDefinitionKey(String processDefinitionKey)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given process definition key

Specified by:

processDefinitionKey in interface BaseJobQuery<TimerJobQuery, Job>

category

public TimerJobQueryImpl category(String category)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given category

Specified by:

category in interface BaseJobQuery<TimerJobQuery, Job>

categoryLike

public TimerJobQueryImpl categoryLike(String categoryLike)

Description copied from interface: BaseJobQuery

Only select jobs like for the given category value

Specified by:

categoryLike in interface BaseJobQuery<TimerJobQuery, Job>

elementId

public TimerJobQueryImpl elementId(String elementId)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given element id

Specified by:

elementId in interface BaseJobQuery<TimerJobQuery, Job>

elementName

public TimerJobQueryImpl elementName(String elementName)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given element name

Specified by:

elementName in interface BaseJobQuery<TimerJobQuery, Job>

scopeId

public TimerJobQueryImpl scopeId(String scopeId)

Description copied from interface: BaseJobQuery

Only select tasks for the given scope identifier.

Specified by:

scopeId in interface BaseJobQuery<TimerJobQuery, Job>

withoutScopeId

public TimerJobQueryImpl withoutScopeId()

Description copied from interface: BaseJobQuery

Only select jobs without a scope id value.

Specified by:

withoutScopeId in interface BaseJobQuery<TimerJobQuery, Job>

subScopeId

public TimerJobQueryImpl subScopeId(String subScopeId)

Description copied from interface: BaseJobQuery

Only select tasks for the given sub scope identifier.

Specified by:

subScopeId in interface BaseJobQuery<TimerJobQuery, Job>

scopeType

public TimerJobQueryImpl scopeType(String scopeType)

Description copied from interface: BaseJobQuery

Only select tasks for the given scope type.

Specified by:

scopeType in interface BaseJobQuery<TimerJobQuery, Job>

withoutScopeType

public TimerJobQueryImpl withoutScopeType()

Description copied from interface: BaseJobQuery

Only return jobs that do not have a scope type.

Specified by:

withoutScopeType in interface BaseJobQuery<TimerJobQuery, Job>

scopeDefinitionId

public TimerJobQueryImpl scopeDefinitionId(String scopeDefinitionId)

Description copied from interface: BaseJobQuery

Only select tasks for the given scope definition identifier.

Specified by:

scopeDefinitionId in interface BaseJobQuery<TimerJobQuery, Job>

caseInstanceId

public TimerJobQueryImpl caseInstanceId(String caseInstanceId)

Description copied from interface: BaseJobQuery

Only select jobs for the given case instance.

Specified by:

caseInstanceId in interface BaseJobQuery<TimerJobQuery, Job>

caseDefinitionId

public TimerJobQueryImpl caseDefinitionId(String caseDefinitionId)

Description copied from interface: BaseJobQuery

Only select jobs for the given case definition.

Specified by:

caseDefinitionId in interface BaseJobQuery<TimerJobQuery, Job>

caseDefinitionKey

public TimerJobQueryImpl caseDefinitionKey(String caseDefinitionKey)

Description copied from interface: BaseJobQuery

Only select tasks for the given case definition key.

Specified by:

caseDefinitionKey in interface BaseJobQuery<TimerJobQuery, Job>

planItemInstanceId

public TimerJobQueryImpl planItemInstanceId(String planItemInstanceId)

Description copied from interface: BaseJobQuery

Only select jobs for the given plan item instance.

Specified by:

planItemInstanceId in interface BaseJobQuery<TimerJobQuery, Job>

correlationId

public TimerJobQueryImpl correlationId(String correlationId)

Description copied from interface: BaseJobQuery

Only select jobs with the given correlationId.

Specified by:

correlationId in interface BaseJobQuery<TimerJobQuery, Job>

executionId

public TimerJobQueryImpl executionId(String executionId)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given execution

Specified by:

executionId in interface BaseJobQuery<TimerJobQuery, Job>

handlerType

public TimerJobQueryImpl handlerType(String handlerType)

Description copied from interface: TimerJobQuery

Select jobs which have given job handler type

Specified by:

handlerType in interface BaseJobQuery<TimerJobQuery, Job>

Specified by:

handlerType in interface TimerJobQuery

handlerTypes

public TimerJobQuery handlerTypes(Collection<String> handlerTypes)

Description copied from interface: BaseJobQuery

Select jobs which have one of the given job handler type

Specified by:

handlerTypes in interface BaseJobQuery<TimerJobQuery, Job>

executable

public TimerJobQueryImpl executable()

Description copied from interface: TimerJobQuery

Only select jobs which are executable, ie. duedate is null or duedate is in the past

Specified by:

executable in interface TimerJobQuery

timers

public TimerJobQueryImpl timers()

Description copied from interface: TimerJobQuery

Only select jobs that are timers. Cannot be used together with TimerJobQuery.messages()

Specified by:

timers in interface TimerJobQuery

messages

public TimerJobQueryImpl messages()

Description copied from interface: TimerJobQuery

Only select jobs that are messages. Cannot be used together with TimerJobQuery.timers()

Specified by:

messages in interface TimerJobQuery

duedateHigherThan

public TimerJobQueryImpl duedateHigherThan(Date date)

Description copied from interface: BaseJobQuery

Only select jobs where the duedate is higher then the given date.

Specified by:

duedateHigherThan in interface BaseJobQuery<TimerJobQuery, Job>

duedateLowerThan

public TimerJobQueryImpl duedateLowerThan(Date date)

Description copied from interface: BaseJobQuery

Only select jobs where the duedate is lower than the given date.

Specified by:

duedateLowerThan in interface BaseJobQuery<TimerJobQuery, Job>

withException

public TimerJobQueryImpl withException()

Description copied from interface: BaseJobQuery

Only select jobs that failed due to an exception.

Specified by:

withException in interface BaseJobQuery<TimerJobQuery, Job>

exceptionMessage

public TimerJobQueryImpl exceptionMessage(String exceptionMessage)

Description copied from interface: BaseJobQuery

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

Specified by:

exceptionMessage in interface BaseJobQuery<TimerJobQuery, Job>

jobTenantId

public TimerJobQueryImpl jobTenantId(String tenantId)

Description copied from interface: BaseJobQuery

Only select jobs that have the given tenant id.

Specified by:

jobTenantId in interface BaseJobQuery<TimerJobQuery, Job>

jobTenantIdLike

public TimerJobQueryImpl jobTenantIdLike(String tenantIdLike)

Description copied from interface: BaseJobQuery

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

Specified by:

jobTenantIdLike in interface BaseJobQuery<TimerJobQuery, Job>

jobWithoutTenantId

public TimerJobQueryImpl jobWithoutTenantId()

Description copied from interface: BaseJobQuery

Only select jobs that do not have a tenant id.

Specified by:

jobWithoutTenantId in interface BaseJobQuery<TimerJobQuery, Job>

or

public TimerJobQuery or()

Description copied from interface: BaseJobQuery

Begin an OR statement. Make sure you invoke the endOr method at the end of your OR statement.

Specified by:

or in interface BaseJobQuery<TimerJobQuery, Job>

endOr

public TimerJobQuery endOr()

Description copied from interface: BaseJobQuery

End an OR statement.

Specified by:

endOr in interface BaseJobQuery<TimerJobQuery, Job>

orderByJobDuedate

public TimerJobQuery orderByJobDuedate()

Description copied from interface: BaseJobQuery

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

Specified by:

orderByJobDuedate in interface BaseJobQuery<TimerJobQuery, Job>

orderByJobCreateTime

public TimerJobQuery orderByJobCreateTime()

Description copied from interface: BaseJobQuery

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

Specified by:

orderByJobCreateTime in interface BaseJobQuery<TimerJobQuery, Job>

orderByExecutionId

public TimerJobQuery orderByExecutionId()

Description copied from interface: BaseJobQuery

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

Specified by:

orderByExecutionId in interface BaseJobQuery<TimerJobQuery, Job>

orderByJobId

public TimerJobQuery orderByJobId()

Description copied from interface: BaseJobQuery

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

Specified by:

orderByJobId in interface BaseJobQuery<TimerJobQuery, Job>

orderByProcessInstanceId

public TimerJobQuery orderByProcessInstanceId()

Description copied from interface: BaseJobQuery

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

Specified by:

orderByProcessInstanceId in interface BaseJobQuery<TimerJobQuery, Job>

orderByJobRetries

public TimerJobQuery orderByJobRetries()

Description copied from interface: BaseJobQuery

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

Specified by:

orderByJobRetries in interface BaseJobQuery<TimerJobQuery, Job>

orderByTenantId

public TimerJobQuery orderByTenantId()

Description copied from interface: BaseJobQuery

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

Specified by:

orderByTenantId in interface BaseJobQuery<TimerJobQuery, Job>

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<TimerJobQuery, Job>

executeList

public List<Job> executeList(CommandContext commandContext)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<TimerJobQuery, Job>

getProcessInstanceId

public String getProcessInstanceId()

isWithoutProcessInstanceId

public boolean isWithoutProcessInstanceId()

getExecutionId

public String getExecutionId()

getHandlerType

public String getHandlerType()

getHandlerTypes

public Collection<String> getHandlerTypes()

getExecutable

public boolean getExecutable()

getNow

public Date getNow()

isWithException

public boolean isWithException()

getExceptionMessage

public String getExceptionMessage()

getTenantId

public String getTenantId()

getTenantIdLike

public String getTenantIdLike()

isWithoutTenantId

public boolean isWithoutTenantId()

getId

public String getId()

getProcessDefinitionId

public String getProcessDefinitionId()

getProcessDefinitionKey

public String getProcessDefinitionKey()

getCategory

public String getCategory()

getCategoryLike

public String getCategoryLike()

getElementId

public String getElementId()

getElementName

public String getElementName()

getScopeId

public String getScopeId()

isWithoutScopeId

public boolean isWithoutScopeId()

getSubScopeId

public String getSubScopeId()

getScopeType

public String getScopeType()

isWithoutScopeType

public boolean isWithoutScopeType()

getScopeDefinitionId

public String getScopeDefinitionId()

getCaseDefinitionKey

public String getCaseDefinitionKey()

getCorrelationId

public String getCorrelationId()

isOnlyTimers

public boolean isOnlyTimers()

isOnlyMessages

public boolean isOnlyMessages()

getDuedateHigherThan

public Date getDuedateHigherThan()

getDuedateLowerThan

public Date getDuedateLowerThan()

getDuedateHigherThanOrEqual

public Date getDuedateHigherThanOrEqual()

getDuedateLowerThanOrEqual

public Date getDuedateLowerThanOrEqual()

isExecutable

public boolean isExecutable()

getOrQueryObjects

public List<TimerJobQueryImpl> getOrQueryObjects()