Package org.flowable.job.service.impl

Class JobQueryImpl

java.lang.Object

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

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

org.flowable.job.service.impl.JobQueryImpl

All Implemented Interfaces:

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

public class JobQueryImpl
extends AbstractQuery<JobQuery,Job>
implements JobQuery, 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	caseDefinitionKey
protected String	category
protected String	categoryLike
protected String	correlationId
protected Date	duedateHigherThan
protected Date	duedateHigherThanOrEqual
protected Date	duedateLowerThan
protected Date	duedateLowerThanOrEqual
protected String	elementId
protected String	elementName
protected String	exceptionMessage
protected String	executionId
protected String	handlerType
protected Collection<String>	handlerTypes
protected String	id
protected Collection<String>	jobIds
protected JobServiceConfiguration	jobServiceConfiguration
protected String	lockOwner
protected boolean	onlyLocked
protected boolean	onlyMessages
protected boolean	onlyTimers
protected boolean	onlyUnlocked
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 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
JobQueryImpl()
JobQueryImpl(CommandContext commandContext, JobServiceConfiguration jobServiceConfiguration)
JobQueryImpl(CommandExecutor commandExecutor, JobServiceConfiguration jobServiceConfiguration)

Method Summary

Modifier and Type	Method	Description
JobQueryImpl	caseDefinitionId(String caseDefinitionId)	Only select jobs for the given case definition.
JobQueryImpl	caseDefinitionKey(String caseDefinitionKey)	Only select tasks for the given case definition key.
JobQueryImpl	caseInstanceId(String caseInstanceId)	Only select jobs for the given case instance.
JobQueryImpl	category(String category)	Only select jobs which exist for the given category
JobQueryImpl	categoryLike(String categoryLike)	Only select jobs like for the given category value
JobQueryImpl	correlationId(String correlationId)	Only select jobs with the given correlationId.
JobQuery	duedateHigherThan(Date date)	Only select jobs where the duedate is higher then the given date.
JobQuery	duedateLowerThan(Date date)	Only select jobs where the duedate is lower than the given date.
JobQueryImpl	elementId(String elementId)	Only select jobs which exist for the given element id
JobQueryImpl	elementName(String elementName)	Only select jobs which exist for the given element name
JobQuery	exceptionMessage(String exceptionMessage)	Only select jobs that failed due to an exception with the given message.
long	executeCount(CommandContext commandContext)
List<Job>	executeList(CommandContext commandContext)	Executes the actual query to retrieve the list of results.
JobQueryImpl	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()
String	getExecutionId()
String	getHandlerType()
Collection<String>	getHandlerTypes()
String	getId()
String	getLockOwner()
Date	getNow()
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
String	getProcessInstanceId()
String	getScopeDefinitionId()
String	getScopeId()
String	getScopeType()
String	getSubScopeId()
String	getTenantId()
String	getTenantIdLike()
JobQueryImpl	handlerType(String handlerType)	Select jobs which have given job handler type
JobQuery	handlerTypes(Collection<String> handlerTypes)	Select jobs which have one of the given job handler type
boolean	isOnlyLocked()
boolean	isOnlyMessages()
boolean	isOnlyTimers()
boolean	isOnlyUnlocked()
boolean	isWithException()
boolean	isWithoutProcessInstanceId()
boolean	isWithoutScopeId()
boolean	isWithoutScopeType()
boolean	isWithoutTenantId()
JobQuery	jobId(String jobId)	Only select jobs with the given id
JobQuery	jobIds(Collection<String> jobIds)	Only select jobs with the given ids.
JobQuery	jobTenantId(String tenantId)	Only select jobs that have the given tenant id.
JobQuery	jobTenantIdLike(String tenantIdLike)	Only select jobs with a tenant id like the given one.
JobQuery	jobWithoutTenantId()	Only select jobs that do not have a tenant id.
JobQuery	locked()	Only return jobs that are locked (i.e.
JobQuery	lockOwner(String lockOwner)	Only return jobs with the given lock owner.
JobQuery	messages()	Only select jobs that are messages.
JobQuery	orderByExecutionId()	Order by execution id (needs to be followed by Query.asc() or Query.desc()).
JobQuery	orderByJobCreateTime()	Order by create time (needs to be followed by Query.asc() or Query.desc()).
JobQuery	orderByJobDuedate()	Order by duedate (needs to be followed by Query.asc() or Query.desc()).
JobQuery	orderByJobId()	Order by job id (needs to be followed by Query.asc() or Query.desc()).
JobQuery	orderByJobRetries()	Order by retries (needs to be followed by Query.asc() or Query.desc()).
JobQuery	orderByProcessInstanceId()	Order by process instance id (needs to be followed by Query.asc() or Query.desc()).
JobQuery	orderByTenantId()	Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
JobQueryImpl	planItemInstanceId(String planItemInstanceId)	Only select jobs for the given plan item instance.
JobQueryImpl	processDefinitionId(String processDefinitionId)	Only select jobs which exist for the given process definition id
JobQueryImpl	processDefinitionKey(String processDefinitionKey)	Only select jobs which exist for the given process definition key
JobQueryImpl	processInstanceId(String processInstanceId)	Only select jobs which exist for the given process instance.
JobQueryImpl	scopeDefinitionId(String scopeDefinitionId)	Only select tasks for the given scope definition identifier.
JobQueryImpl	scopeId(String scopeId)	Only select tasks for the given scope identifier.
JobQueryImpl	scopeType(String scopeType)	Only select tasks for the given scope type.
JobQueryImpl	subScopeId(String subScopeId)	Only select tasks for the given sub scope identifier.
JobQuery	timers()	Only select jobs that are timers.
JobQuery	unlocked()	Only return jobs that are not locked.
JobQuery	withException()	Only select jobs that failed due to an exception.
JobQuery	withoutProcessInstanceId()	Only select jobs without a process instance id value.
JobQuery	withoutScopeId()	Only select jobs without a scope id value.
JobQuery	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

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

scopeDefinitionId

protected String scopeDefinitionId

caseDefinitionKey

protected String caseDefinitionKey

correlationId

protected String correlationId

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

withoutScopeType

protected boolean withoutScopeType

lockOwner

protected String lockOwner

onlyLocked

protected boolean onlyLocked

onlyUnlocked

protected boolean onlyUnlocked

Constructor Details

JobQueryImpl

public JobQueryImpl()

JobQueryImpl

public JobQueryImpl(CommandContext commandContext,
 JobServiceConfiguration jobServiceConfiguration)

JobQueryImpl

public JobQueryImpl(CommandExecutor commandExecutor,
 JobServiceConfiguration jobServiceConfiguration)

Method Details

jobId

public JobQuery jobId(String jobId)

Description copied from interface: BaseJobQuery

Only select jobs with the given id

Specified by:

jobId in interface BaseJobQuery<JobQuery,Job>

jobIds

public JobQuery 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<JobQuery,Job>

processInstanceId

public JobQueryImpl processInstanceId(String processInstanceId)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given process instance.

Specified by:

processInstanceId in interface BaseJobQuery<JobQuery,Job>

withoutProcessInstanceId

public JobQuery withoutProcessInstanceId()

Description copied from interface: BaseJobQuery

Only select jobs without a process instance id value.

Specified by:

withoutProcessInstanceId in interface BaseJobQuery<JobQuery,Job>

processDefinitionId

public JobQueryImpl 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<JobQuery,Job>

processDefinitionKey

public JobQueryImpl 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<JobQuery,Job>

category

public JobQueryImpl category(String category)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given category

Specified by:

category in interface BaseJobQuery<JobQuery,Job>

categoryLike

public JobQueryImpl categoryLike(String categoryLike)

Description copied from interface: BaseJobQuery

Only select jobs like for the given category value

Specified by:

categoryLike in interface BaseJobQuery<JobQuery,Job>

elementId

public JobQueryImpl elementId(String elementId)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given element id

Specified by:

elementId in interface BaseJobQuery<JobQuery,Job>

elementName

public JobQueryImpl elementName(String elementName)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given element name

Specified by:

elementName in interface BaseJobQuery<JobQuery,Job>

scopeId

public JobQueryImpl scopeId(String scopeId)

Description copied from interface: BaseJobQuery

Only select tasks for the given scope identifier.

Specified by:

scopeId in interface BaseJobQuery<JobQuery,Job>

withoutScopeId

public JobQuery withoutScopeId()

Description copied from interface: BaseJobQuery

Only select jobs without a scope id value.

Specified by:

withoutScopeId in interface BaseJobQuery<JobQuery,Job>

subScopeId

public JobQueryImpl subScopeId(String subScopeId)

Description copied from interface: BaseJobQuery

Only select tasks for the given sub scope identifier.

Specified by:

subScopeId in interface BaseJobQuery<JobQuery,Job>

scopeType

public JobQueryImpl scopeType(String scopeType)

Description copied from interface: BaseJobQuery

Only select tasks for the given scope type.

Specified by:

scopeType in interface BaseJobQuery<JobQuery,Job>

scopeDefinitionId

public JobQueryImpl scopeDefinitionId(String scopeDefinitionId)

Description copied from interface: BaseJobQuery

Only select tasks for the given scope definition identifier.

Specified by:

scopeDefinitionId in interface BaseJobQuery<JobQuery,Job>

caseInstanceId

public JobQueryImpl caseInstanceId(String caseInstanceId)

Description copied from interface: BaseJobQuery

Only select jobs for the given case instance.

Specified by:

caseInstanceId in interface BaseJobQuery<JobQuery,Job>

caseDefinitionId

public JobQueryImpl caseDefinitionId(String caseDefinitionId)

Description copied from interface: BaseJobQuery

Only select jobs for the given case definition.

Specified by:

caseDefinitionId in interface BaseJobQuery<JobQuery,Job>

caseDefinitionKey

public JobQueryImpl caseDefinitionKey(String caseDefinitionKey)

Description copied from interface: BaseJobQuery

Only select tasks for the given case definition key.

Specified by:

caseDefinitionKey in interface BaseJobQuery<JobQuery,Job>

planItemInstanceId

public JobQueryImpl planItemInstanceId(String planItemInstanceId)

Description copied from interface: BaseJobQuery

Only select jobs for the given plan item instance.

Specified by:

planItemInstanceId in interface BaseJobQuery<JobQuery,Job>

correlationId

public JobQueryImpl correlationId(String correlationId)

Description copied from interface: BaseJobQuery

Only select jobs with the given correlationId.

Specified by:

correlationId in interface BaseJobQuery<JobQuery,Job>

executionId

public JobQueryImpl executionId(String executionId)

Description copied from interface: BaseJobQuery

Only select jobs which exist for the given execution

Specified by:

executionId in interface BaseJobQuery<JobQuery,Job>

handlerType

public JobQueryImpl handlerType(String handlerType)

Description copied from interface: BaseJobQuery

Select jobs which have given job handler type

Specified by:

handlerType in interface BaseJobQuery<JobQuery,Job>

handlerTypes

public JobQuery 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<JobQuery,Job>

timers

public JobQuery timers()

Description copied from interface: JobQuery

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

Specified by:

timers in interface JobQuery

messages

public JobQuery messages()

Description copied from interface: JobQuery

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

Specified by:

messages in interface JobQuery

duedateHigherThan

public JobQuery 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<JobQuery,Job>

duedateLowerThan

public JobQuery 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<JobQuery,Job>

withException

public JobQuery withException()

Description copied from interface: BaseJobQuery

Only select jobs that failed due to an exception.

Specified by:

withException in interface BaseJobQuery<JobQuery,Job>

exceptionMessage

public JobQuery 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<JobQuery,Job>

jobTenantId

public JobQuery jobTenantId(String tenantId)

Description copied from interface: BaseJobQuery

Only select jobs that have the given tenant id.

Specified by:

jobTenantId in interface BaseJobQuery<JobQuery,Job>

jobTenantIdLike

public JobQuery 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<JobQuery,Job>

jobWithoutTenantId

public JobQuery jobWithoutTenantId()

Description copied from interface: BaseJobQuery

Only select jobs that do not have a tenant id.

Specified by:

jobWithoutTenantId in interface BaseJobQuery<JobQuery,Job>

lockOwner

public JobQuery lockOwner(String lockOwner)

Description copied from interface: JobQuery

Only return jobs with the given lock owner.

Specified by:

lockOwner in interface JobQuery

locked

public JobQuery locked()

Description copied from interface: JobQuery

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

Specified by:

locked in interface JobQuery

unlocked

public JobQuery unlocked()

Description copied from interface: JobQuery

Only return jobs that are not locked.

Specified by:

unlocked in interface JobQuery

withoutScopeType

public JobQuery withoutScopeType()

Description copied from interface: BaseJobQuery

Only return jobs that do not have a scope type.

Specified by:

withoutScopeType in interface BaseJobQuery<JobQuery,Job>

orderByJobDuedate

public JobQuery 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<JobQuery,Job>

orderByJobCreateTime

public JobQuery 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<JobQuery,Job>

orderByExecutionId

public JobQuery 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<JobQuery,Job>

orderByJobId

public JobQuery 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<JobQuery,Job>

orderByProcessInstanceId

public JobQuery 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<JobQuery,Job>

orderByJobRetries

public JobQuery 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<JobQuery,Job>

orderByTenantId

public JobQuery 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<JobQuery,Job>

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<JobQuery,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<JobQuery,Job>

getProcessInstanceId

public String getProcessInstanceId()

isWithoutProcessInstanceId

public boolean isWithoutProcessInstanceId()

getExecutionId

public String getExecutionId()

getHandlerType

public String getHandlerType()

getHandlerTypes

public Collection<String> getHandlerTypes()

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()

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()

getLockOwner

public String getLockOwner()

isOnlyLocked

public boolean isOnlyLocked()

isOnlyUnlocked

public boolean isOnlyUnlocked()

isWithoutScopeType

public boolean isWithoutScopeType()