org.camunda.bpm.engine.impl

Class DeploymentQueryImpl

java.lang.Object

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

org.camunda.bpm.engine.impl.AbstractQuery<DeploymentQuery,Deployment>

org.camunda.bpm.engine.impl.DeploymentQueryImpl

All Implemented Interfaces:

Serializable, Command<Object>, Query<DeploymentQuery,Deployment>, DeploymentQuery

public class DeploymentQueryImpl
extends AbstractQuery<DeploymentQuery,Deployment>
implements DeploymentQuery, Serializable

Author:

Tom Baeyens, Joram Barrez, Ingo Richtsmeier

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 Date	deploymentAfter
protected Date	deploymentBefore
protected String	deploymentId
protected boolean	includeDeploymentsWithoutTenantId
protected boolean	isTenantIdSet
protected String	name
protected String	nameLike
protected String	source
protected boolean	sourceQueryParamEnabled
protected String[]	tenantIds

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
DeploymentQueryImpl()
DeploymentQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method and Description
DeploymentQuery	deploymentAfter(Date after) Only select deployments deployed after the given date
DeploymentQuery	deploymentBefore(Date before) Only select deployments deployed before the given date
DeploymentQueryImpl	deploymentId(String deploymentId) Only select deployments with the given deployment id.
DeploymentQueryImpl	deploymentName(String deploymentName) Only select deployments with the given name.
DeploymentQueryImpl	deploymentNameLike(String nameLike) Only select deployments with a name like the given string.
DeploymentQuery	deploymentSource(String source) If the given source is null, then deployments are returned where source is equal to null.
long	executeCount(CommandContext commandContext)
List<Deployment>	executeList(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.
Date	getDeploymentAfter()
Date	getDeploymentBefore()
String	getDeploymentId()
String	getName()
String	getNameLike()
String	getSource()
protected boolean	hasExcludingConditions() Whether or not the query has excluding conditions.
DeploymentQuery	includeDeploymentsWithoutTenantId() Select deployments which have no tenant id.
boolean	isSourceQueryParamEnabled()
DeploymentQuery	orderByDeploymentId() Order by deployment id (needs to be followed by Query.asc() or Query.desc()).
DeploymentQuery	orderByDeploymenTime() Order by deployment time (needs to be followed by Query.asc() or Query.desc()).
DeploymentQuery	orderByDeploymentName() Order by deployment name (needs to be followed by Query.asc() or Query.desc()).
DeploymentQuery	orderByDeploymentTime() Order by deployment time (needs to be followed by Query.asc() or Query.desc()).
DeploymentQuery	orderByTenantId() Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
DeploymentQuery	tenantIdIn(String... tenantIds) Only select deployments with one of the given tenant ids.
DeploymentQuery	withoutTenantId() Only select deployments which have no tenant id.

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, 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

deploymentId

protected String deploymentId

name

protected String name

nameLike

protected String nameLike

sourceQueryParamEnabled

protected boolean sourceQueryParamEnabled

source

protected String source

deploymentBefore

protected Date deploymentBefore

deploymentAfter

protected Date deploymentAfter

isTenantIdSet

protected boolean isTenantIdSet

tenantIds

protected String[] tenantIds

includeDeploymentsWithoutTenantId

protected boolean includeDeploymentsWithoutTenantId

Constructor Detail

DeploymentQueryImpl

public DeploymentQueryImpl()

DeploymentQueryImpl

public DeploymentQueryImpl(CommandExecutor commandExecutor)

Method Detail

deploymentId

public DeploymentQueryImpl deploymentId(String deploymentId)

Description copied from interface: DeploymentQuery

Only select deployments with the given deployment id.

Specified by:

deploymentId in interface DeploymentQuery

deploymentName

public DeploymentQueryImpl deploymentName(String deploymentName)

Description copied from interface: DeploymentQuery

Only select deployments with the given name.

Specified by:

deploymentName in interface DeploymentQuery

deploymentNameLike

public DeploymentQueryImpl deploymentNameLike(String nameLike)

Description copied from interface: DeploymentQuery

Only select deployments with a name like the given string.

Specified by:

deploymentNameLike in interface DeploymentQuery

deploymentSource

public DeploymentQuery deploymentSource(String source)

Description copied from interface: DeploymentQuery

If the given source is null, then deployments are returned where source is equal to null. Otherwise only deployments with the given source are selected.

Specified by:

deploymentSource in interface DeploymentQuery

deploymentBefore

public DeploymentQuery deploymentBefore(Date before)

Description copied from interface: DeploymentQuery

Only select deployments deployed before the given date

Specified by:

deploymentBefore in interface DeploymentQuery

deploymentAfter

public DeploymentQuery deploymentAfter(Date after)

Description copied from interface: DeploymentQuery

Only select deployments deployed after the given date

Specified by:

deploymentAfter in interface DeploymentQuery

tenantIdIn

public DeploymentQuery tenantIdIn(String... tenantIds)

Description copied from interface: DeploymentQuery

Only select deployments with one of the given tenant ids.

Specified by:

tenantIdIn in interface DeploymentQuery

withoutTenantId

public DeploymentQuery withoutTenantId()

Description copied from interface: DeploymentQuery

Only select deployments which have no tenant id.

Specified by:

withoutTenantId in interface DeploymentQuery

includeDeploymentsWithoutTenantId

public DeploymentQuery includeDeploymentsWithoutTenantId()

Description copied from interface: DeploymentQuery

Select deployments which have no tenant id. Can be used in combination with DeploymentQuery.tenantIdIn(String...).

Specified by:

includeDeploymentsWithoutTenantId in interface DeploymentQuery

hasExcludingConditions

protected boolean hasExcludingConditions()

Description copied from class: AbstractQuery

Whether or not the query has excluding conditions. If the query has excluding conditions, (e.g. task due date before and after are excluding), the SQL query is avoided and a default result is returned. The returned result is the same as if the SQL was executed and there were no entries.

Overrides:

hasExcludingConditions in class AbstractQuery<DeploymentQuery,Deployment>

Returns:

true if the query does have excluding conditions, false otherwise

orderByDeploymentId

public DeploymentQuery orderByDeploymentId()

Description copied from interface: DeploymentQuery

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

Specified by:

orderByDeploymentId in interface DeploymentQuery

orderByDeploymenTime

public DeploymentQuery orderByDeploymenTime()

Description copied from interface: DeploymentQuery

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

Specified by:

orderByDeploymenTime in interface DeploymentQuery

orderByDeploymentTime

public DeploymentQuery orderByDeploymentTime()

Description copied from interface: DeploymentQuery

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

Specified by:

orderByDeploymentTime in interface DeploymentQuery

orderByDeploymentName

public DeploymentQuery orderByDeploymentName()

Description copied from interface: DeploymentQuery

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

Specified by:

orderByDeploymentName in interface DeploymentQuery

orderByTenantId

public DeploymentQuery orderByTenantId()

Description copied from interface: DeploymentQuery

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

Specified by:

orderByTenantId in interface DeploymentQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<DeploymentQuery,Deployment>

executeList

public List<Deployment> 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<DeploymentQuery,Deployment>

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

getDeploymentId

public String getDeploymentId()

getName

public String getName()

getNameLike

public String getNameLike()

isSourceQueryParamEnabled

public boolean isSourceQueryParamEnabled()

getSource

public String getSource()

getDeploymentBefore

public Date getDeploymentBefore()

getDeploymentAfter

public Date getDeploymentAfter()