org.camunda.bpm.engine.impl

Class JobDefinitionQueryImpl

java.lang.Object

org.camunda.bpm.engine.impl.db.ListQueryParameterObject

org.camunda.bpm.engine.impl.AbstractQuery<JobDefinitionQuery,JobDefinition>

org.camunda.bpm.engine.impl.JobDefinitionQueryImpl

All Implemented Interfaces:

Serializable, Command<Object>, JobDefinitionQuery, Query<JobDefinitionQuery,JobDefinition>

public class JobDefinitionQueryImpl
extends AbstractQuery<JobDefinitionQuery,JobDefinition>
implements JobDefinitionQuery, Serializable

Author:

roman.smirnov

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery

AbstractQuery.ResultType

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	activityIds
protected String	id
protected boolean	includeJobDefinitionsWithoutTenantId
protected boolean	isTenantIdSet
protected String	jobConfiguration
protected String	jobType
protected String	processDefinitionId
protected String	processDefinitionKey
protected SuspensionState	suspensionState
protected String[]	tenantIds
protected Boolean	withOverridingJobPriority

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

commandExecutor, expressions, maxResultsLimitEnabled, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck

Constructor Summary

Constructors

Constructor and Description
JobDefinitionQueryImpl()
JobDefinitionQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method and Description
JobDefinitionQuery	active() Only selects job definitions which are active
JobDefinitionQuery	activityIdIn(String... activityIds) Only select job definitions which exist for the listed activity ids
long	executeCount(CommandContext commandContext)
List<JobDefinition>	executeList(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.
String[]	getActivityIds()
String	getId()
String	getJobConfiguration()
String	getJobType()
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
SuspensionState	getSuspensionState()
Boolean	getWithOverridingJobPriority()
JobDefinitionQuery	includeJobDefinitionsWithoutTenantId() Select job definitions which have no tenant id.
JobDefinitionQuery	jobConfiguration(String jobConfiguration) Only select job definitions which contain the configuration.
JobDefinitionQuery	jobDefinitionId(String jobDefinitionId) Only select job definitions with the given id
JobDefinitionQuery	jobType(String jobType) Only select job definitions which have the given job type.
JobDefinitionQuery	orderByActivityId() Order by activty id (needs to be followed by Query.asc() or Query.desc()).
JobDefinitionQuery	orderByJobConfiguration() Order by job configuration (needs to be followed by Query.asc() or Query.desc()).
JobDefinitionQuery	orderByJobDefinitionId() Order by id (needs to be followed by Query.asc() or Query.desc()).
JobDefinitionQuery	orderByJobType() Order by job type (needs to be followed by Query.asc() or Query.desc()).
JobDefinitionQuery	orderByProcessDefinitionId() Order by process defintion id (needs to be followed by Query.asc() or Query.desc()).
JobDefinitionQuery	orderByProcessDefinitionKey() Order by process definition key (needs to be followed by Query.asc() or Query.desc()).
JobDefinitionQuery	orderByTenantId() Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
JobDefinitionQuery	processDefinitionId(String processDefinitionId) Only select job definitions which exist for the given process definition id.
JobDefinitionQuery	processDefinitionKey(String processDefinitionKey) Only select job definitions which exist for the given process definition key.
JobDefinitionQuery	suspended() Only selects job definitions which are suspended
JobDefinitionQuery	tenantIdIn(String... tenantIds) Only select job definitions that belong to one of the given tenant ids.
JobDefinitionQuery	withoutTenantId() Only select job definitions which have no tenant id.
JobDefinitionQuery	withOverridingJobPriority() Only selects job definitions which have a job priority defined.

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

addExpression, addValidator, asc, checkMaxResultsLimit, checkQueryOk, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeIdsList, executeResult, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unboundedResultList, validate, validate

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.camunda.bpm.engine.query.Query

asc, count, desc, list, listPage, singleResult

Field Detail

id

protected String id

activityIds

protected String[] activityIds

processDefinitionId

protected String processDefinitionId

processDefinitionKey

protected String processDefinitionKey

jobType

protected String jobType

jobConfiguration

protected String jobConfiguration

suspensionState

protected SuspensionState suspensionState

withOverridingJobPriority

protected Boolean withOverridingJobPriority

isTenantIdSet

protected boolean isTenantIdSet

tenantIds

protected String[] tenantIds

includeJobDefinitionsWithoutTenantId

protected boolean includeJobDefinitionsWithoutTenantId

Constructor Detail

JobDefinitionQueryImpl

public JobDefinitionQueryImpl()

JobDefinitionQueryImpl

public JobDefinitionQueryImpl(CommandExecutor commandExecutor)

Method Detail

jobDefinitionId

public JobDefinitionQuery jobDefinitionId(String jobDefinitionId)

Description copied from interface: JobDefinitionQuery

Only select job definitions with the given id

Specified by:

jobDefinitionId in interface JobDefinitionQuery

activityIdIn

public JobDefinitionQuery activityIdIn(String... activityIds)

Description copied from interface: JobDefinitionQuery

Only select job definitions which exist for the listed activity ids

Specified by:

activityIdIn in interface JobDefinitionQuery

processDefinitionId

public JobDefinitionQuery processDefinitionId(String processDefinitionId)

Description copied from interface: JobDefinitionQuery

Only select job definitions which exist for the given process definition id.

Specified by:

processDefinitionId in interface JobDefinitionQuery

processDefinitionKey

public JobDefinitionQuery processDefinitionKey(String processDefinitionKey)

Description copied from interface: JobDefinitionQuery

Only select job definitions which exist for the given process definition key.

Specified by:

processDefinitionKey in interface JobDefinitionQuery

jobType

public JobDefinitionQuery jobType(String jobType)

Description copied from interface: JobDefinitionQuery

Only select job definitions which have the given job type.

Specified by:

jobType in interface JobDefinitionQuery

jobConfiguration

public JobDefinitionQuery jobConfiguration(String jobConfiguration)

Description copied from interface: JobDefinitionQuery

Only select job definitions which contain the configuration.

Specified by:

jobConfiguration in interface JobDefinitionQuery

active

public JobDefinitionQuery active()

Description copied from interface: JobDefinitionQuery

Only selects job definitions which are active

Specified by:

active in interface JobDefinitionQuery

suspended

public JobDefinitionQuery suspended()

Description copied from interface: JobDefinitionQuery

Only selects job definitions which are suspended

Specified by:

suspended in interface JobDefinitionQuery

withOverridingJobPriority

public JobDefinitionQuery withOverridingJobPriority()

Description copied from interface: JobDefinitionQuery

Only selects job definitions which have a job priority defined.

Specified by:

withOverridingJobPriority in interface JobDefinitionQuery

tenantIdIn

public JobDefinitionQuery tenantIdIn(String... tenantIds)

Description copied from interface: JobDefinitionQuery

Only select job definitions that belong to one of the given tenant ids.

Specified by:

tenantIdIn in interface JobDefinitionQuery

withoutTenantId

public JobDefinitionQuery withoutTenantId()

Description copied from interface: JobDefinitionQuery

Only select job definitions which have no tenant id.

Specified by:

withoutTenantId in interface JobDefinitionQuery

includeJobDefinitionsWithoutTenantId

public JobDefinitionQuery includeJobDefinitionsWithoutTenantId()

Description copied from interface: JobDefinitionQuery

Select job definitions which have no tenant id. Can be used in combination with JobDefinitionQuery.tenantIdIn(String...).

Specified by:

includeJobDefinitionsWithoutTenantId in interface JobDefinitionQuery

orderByJobDefinitionId

public JobDefinitionQuery orderByJobDefinitionId()

Description copied from interface: JobDefinitionQuery

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

Specified by:

orderByJobDefinitionId in interface JobDefinitionQuery

orderByActivityId

public JobDefinitionQuery orderByActivityId()

Description copied from interface: JobDefinitionQuery

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

Specified by:

orderByActivityId in interface JobDefinitionQuery

orderByProcessDefinitionId

public JobDefinitionQuery orderByProcessDefinitionId()

Description copied from interface: JobDefinitionQuery

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

Specified by:

orderByProcessDefinitionId in interface JobDefinitionQuery

orderByProcessDefinitionKey

public JobDefinitionQuery orderByProcessDefinitionKey()

Description copied from interface: JobDefinitionQuery

Order by process definition key (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByProcessDefinitionKey in interface JobDefinitionQuery

orderByJobType

public JobDefinitionQuery orderByJobType()

Description copied from interface: JobDefinitionQuery

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

Specified by:

orderByJobType in interface JobDefinitionQuery

orderByJobConfiguration

public JobDefinitionQuery orderByJobConfiguration()

Description copied from interface: JobDefinitionQuery

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

Specified by:

orderByJobConfiguration in interface JobDefinitionQuery

orderByTenantId

public JobDefinitionQuery orderByTenantId()

Description copied from interface: JobDefinitionQuery

Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of job definitions without tenant id is database-specific.

Specified by:

orderByTenantId in interface JobDefinitionQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<JobDefinitionQuery,JobDefinition>

executeList

public List<JobDefinition> executeList(CommandContext commandContext,
                                       Page page)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<JobDefinitionQuery,JobDefinition>

page - used if the results must be paged. If null, no paging will be applied.

getId

public String getId()

getActivityIds

public String[] getActivityIds()

getProcessDefinitionId

public String getProcessDefinitionId()

getProcessDefinitionKey

public String getProcessDefinitionKey()

getJobType

public String getJobType()

getJobConfiguration

public String getJobConfiguration()

getSuspensionState

public SuspensionState getSuspensionState()

getWithOverridingJobPriority

public Boolean getWithOverridingJobPriority()