Package org.flowable.engine.impl

Class ModelQueryImpl

java.lang.Object

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

org.flowable.common.engine.impl.query.AbstractQuery<ModelQuery,Model>

org.flowable.engine.impl.ModelQueryImpl

All Implemented Interfaces:

Serializable, Query<ModelQuery,Model>, Command<Object>, ModelQuery

public class ModelQueryImpl
extends AbstractQuery<ModelQuery,Model>
implements ModelQuery

Author:

Tijs Rademakers, Joram Barrez

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	category
protected String	categoryLike
protected String	categoryNotEquals
protected boolean	deployed
protected String	deploymentId
protected String	id
protected String	key
protected boolean	latest
protected String	name
protected String	nameLike
protected boolean	notDeployed
protected String	tenantId
protected String	tenantIdLike
protected Integer	version
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
ModelQueryImpl()
ModelQueryImpl(CommandContext commandContext)
ModelQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
ModelQuery	deployed()	Only select models that are deployed (ie deploymentId != null)
ModelQuery	deploymentId(String deploymentId)	Only select models that are the source for the provided deployment
long	executeCount(CommandContext commandContext)
List<Model>	executeList(CommandContext commandContext)	Executes the actual query to retrieve the list of results.
String	getCategory()
String	getCategoryLike()
String	getCategoryNotEquals()
String	getDeploymentId()
String	getId()
String	getKey()
String	getName()
String	getNameLike()
static long	getSerialversionuid()
String	getTenantId()
String	getTenantIdLike()
Integer	getVersion()
boolean	isDeployed()
boolean	isLatest()
boolean	isNotDeployed()
boolean	isWithoutTenantId()
ModelQuery	latestVersion()	Only select models which has the highest version.
ModelQueryImpl	modelCategory(String category)	Only select models with the given category.
ModelQueryImpl	modelCategoryLike(String categoryLike)	Only select models where the category matches the given parameter.
ModelQueryImpl	modelCategoryNotEquals(String categoryNotEquals)	Only select models that have a different category then the given one.
ModelQueryImpl	modelId(String modelId)	Only select model with the given id.
ModelQuery	modelKey(String key)	Only selects models with the given key.
ModelQueryImpl	modelName(String name)	Only select models with the given name.
ModelQueryImpl	modelNameLike(String nameLike)	Only select models where the name matches the given parameter.
ModelQuery	modelTenantId(String tenantId)	Only select models that have the given tenant id.
ModelQuery	modelTenantIdLike(String tenantIdLike)	Only select models with a tenant id like the given one.
ModelQueryImpl	modelVersion(Integer version)	Only select model with a certain version.
ModelQuery	modelWithoutTenantId()	Only select models that do not have a tenant id.
ModelQuery	notDeployed()	Only select models that are not yet deployed
ModelQuery	orderByCreateTime()	Order by the creation time of the models (needs to be followed by Query.asc() or Query.desc()).
ModelQuery	orderByLastUpdateTime()	Order by the last update time of the models (needs to be followed by Query.asc() or Query.desc()).
ModelQuery	orderByModelCategory()	Order by the category of the models (needs to be followed by Query.asc() or Query.desc()).
ModelQuery	orderByModelId()	Order by the id of the models (needs to be followed by Query.asc() or Query.desc()).
ModelQuery	orderByModelKey()	Order by the key of the models (needs to be followed by Query.asc() or Query.desc()).
ModelQuery	orderByModelName()	Order by the name of the models (needs to be followed by Query.asc() or Query.desc()).
ModelQuery	orderByModelVersion()	Order by the version of the models (needs to be followed by Query.asc() or Query.desc()).
ModelQuery	orderByTenantId()	Order by tenant id (needs to be followed by Query.asc() or Query.desc()).

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

id

protected String id

category

protected String category

categoryLike

protected String categoryLike

categoryNotEquals

protected String categoryNotEquals

name

protected String name

nameLike

protected String nameLike

key

protected String key

version

protected Integer version

latest

protected boolean latest

deploymentId

protected String deploymentId

notDeployed

protected boolean notDeployed

deployed

protected boolean deployed

tenantId

protected String tenantId

tenantIdLike

protected String tenantIdLike

withoutTenantId

protected boolean withoutTenantId

Constructor Details

ModelQueryImpl

public ModelQueryImpl()

ModelQueryImpl

public ModelQueryImpl(CommandContext commandContext)

ModelQueryImpl

public ModelQueryImpl(CommandExecutor commandExecutor)

Method Details

modelId

public ModelQueryImpl modelId(String modelId)

Description copied from interface: ModelQuery

Only select model with the given id.

Specified by:

modelId in interface ModelQuery

modelCategory

public ModelQueryImpl modelCategory(String category)

Description copied from interface: ModelQuery

Only select models with the given category.

Specified by:

modelCategory in interface ModelQuery

modelCategoryLike

public ModelQueryImpl modelCategoryLike(String categoryLike)

Description copied from interface: ModelQuery

Only select models where the category matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%

Specified by:

modelCategoryLike in interface ModelQuery

modelCategoryNotEquals

public ModelQueryImpl modelCategoryNotEquals(String categoryNotEquals)

Description copied from interface: ModelQuery

Only select models that have a different category then the given one.

Specified by:

modelCategoryNotEquals in interface ModelQuery

modelName

public ModelQueryImpl modelName(String name)

Description copied from interface: ModelQuery

Only select models with the given name.

Specified by:

modelName in interface ModelQuery

modelNameLike

public ModelQueryImpl modelNameLike(String nameLike)

Description copied from interface: ModelQuery

Only select models where the name matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%

Specified by:

modelNameLike in interface ModelQuery

modelKey

public ModelQuery modelKey(String key)

Description copied from interface: ModelQuery

Only selects models with the given key.

Specified by:

modelKey in interface ModelQuery

modelVersion

public ModelQueryImpl modelVersion(Integer version)

Description copied from interface: ModelQuery

Only select model with a certain version.

Specified by:

modelVersion in interface ModelQuery

latestVersion

public ModelQuery latestVersion()

Description copied from interface: ModelQuery

Only select models which has the highest version. Note: if modelKey(key) is not used in this query, all the models with the highest version for each key will be returned (similar to process definitions)

Specified by:

latestVersion in interface ModelQuery

deploymentId

public ModelQuery deploymentId(String deploymentId)

Description copied from interface: ModelQuery

Only select models that are the source for the provided deployment

Specified by:

deploymentId in interface ModelQuery

notDeployed

public ModelQuery notDeployed()

Description copied from interface: ModelQuery

Only select models that are not yet deployed

Specified by:

notDeployed in interface ModelQuery

deployed

public ModelQuery deployed()

Description copied from interface: ModelQuery

Only select models that are deployed (ie deploymentId != null)

Specified by:

deployed in interface ModelQuery

modelTenantId

public ModelQuery modelTenantId(String tenantId)

Description copied from interface: ModelQuery

Only select models that have the given tenant id.

Specified by:

modelTenantId in interface ModelQuery

modelTenantIdLike

public ModelQuery modelTenantIdLike(String tenantIdLike)

Description copied from interface: ModelQuery

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

Specified by:

modelTenantIdLike in interface ModelQuery

modelWithoutTenantId

public ModelQuery modelWithoutTenantId()

Description copied from interface: ModelQuery

Only select models that do not have a tenant id.

Specified by:

modelWithoutTenantId in interface ModelQuery

orderByModelCategory

public ModelQuery orderByModelCategory()

Description copied from interface: ModelQuery

Order by the category of the models (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByModelCategory in interface ModelQuery

orderByModelId

public ModelQuery orderByModelId()

Description copied from interface: ModelQuery

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

Specified by:

orderByModelId in interface ModelQuery

orderByModelKey

public ModelQuery orderByModelKey()

Description copied from interface: ModelQuery

Order by the key of the models (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByModelKey in interface ModelQuery

orderByModelVersion

public ModelQuery orderByModelVersion()

Description copied from interface: ModelQuery

Order by the version of the models (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByModelVersion in interface ModelQuery

orderByModelName

public ModelQuery orderByModelName()

Description copied from interface: ModelQuery

Order by the name of the models (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByModelName in interface ModelQuery

orderByCreateTime

public ModelQuery orderByCreateTime()

Description copied from interface: ModelQuery

Order by the creation time of the models (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByCreateTime in interface ModelQuery

orderByLastUpdateTime

public ModelQuery orderByLastUpdateTime()

Description copied from interface: ModelQuery

Order by the last update time of the models (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByLastUpdateTime in interface ModelQuery

orderByTenantId

public ModelQuery orderByTenantId()

Description copied from interface: ModelQuery

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

Specified by:

orderByTenantId in interface ModelQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<ModelQuery,Model>

executeList

public List<Model> executeList(CommandContext commandContext)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<ModelQuery,Model>

getId

public String getId()

getName

public String getName()

getNameLike

public String getNameLike()

getVersion

public Integer getVersion()

getCategory

public String getCategory()

getCategoryLike

public String getCategoryLike()

getCategoryNotEquals

public String getCategoryNotEquals()

getSerialversionuid

public static long getSerialversionuid()

getKey

public String getKey()

isLatest

public boolean isLatest()

getDeploymentId

public String getDeploymentId()

isNotDeployed

public boolean isNotDeployed()

isDeployed

public boolean isDeployed()

getTenantId

public String getTenantId()

getTenantIdLike

public String getTenantIdLike()

isWithoutTenantId

public boolean isWithoutTenantId()