Package org.flowable.eventregistry.impl

Class EventDefinitionQueryImpl

java.lang.Object

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

org.flowable.common.engine.impl.query.AbstractQuery<EventDefinitionQuery,EventDefinition>

org.flowable.eventregistry.impl.EventDefinitionQueryImpl

All Implemented Interfaces:

Serializable, Query<EventDefinitionQuery,EventDefinition>, Command<Object>, EventDefinitionQuery

public class EventDefinitionQueryImpl
extends AbstractQuery<EventDefinitionQuery,EventDefinition>
implements EventDefinitionQuery

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 String	deploymentId
protected Set<String>	deploymentIds
protected String	id
protected Set<String>	ids
protected String	key
protected String	keyLike
protected String	keyLikeIgnoreCase
protected boolean	latest
protected String	name
protected String	nameLike
protected String	nameLikeIgnoreCase
protected String	parentDeploymentId
protected String	resourceName
protected String	resourceNameLike
protected String	tenantId
protected String	tenantIdLike
protected Integer	version
protected Integer	versionGt
protected Integer	versionGte
protected Integer	versionLt
protected Integer	versionLte
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
EventDefinitionQueryImpl()
EventDefinitionQueryImpl(CommandContext commandContext)
EventDefinitionQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
protected void	checkVersion(Integer version)
EventDefinitionQueryImpl	deploymentId(String deploymentId)	Only select event definitions that are deployed in a deployment with the given deployment id
EventDefinitionQueryImpl	deploymentIds(Set<String> deploymentIds)	Select event definitions that are deployed in deployments with the given set of ids
EventDefinitionQueryImpl	eventCategory(String category)	Only select event definitions with the given category.
EventDefinitionQueryImpl	eventCategoryLike(String categoryLike)	Only select event definitions where the category matches the given parameter.
EventDefinitionQueryImpl	eventCategoryNotEquals(String categoryNotEquals)	Only select event definitions that have a different category then the given one.
EventDefinitionQueryImpl	eventDefinitionId(String eventDefinitionId)	Only select eventdefinition with the given id.
EventDefinitionQueryImpl	eventDefinitionIds(Set<String> eventDefinitionIds)	Only select forms with the given ids.
EventDefinitionQueryImpl	eventDefinitionKey(String key)	Only select event definition with the given key.
EventDefinitionQueryImpl	eventDefinitionKeyLike(String keyLike)	Only select event definitions where the key matches the given parameter.
EventDefinitionQueryImpl	eventDefinitionKeyLikeIgnoreCase(String keyLikeIgnoreCase)	Only select event definitions where the key matches the given parameter (case-insensitive).
EventDefinitionQueryImpl	eventDefinitionName(String name)	Only select event definitions with the given name.
EventDefinitionQueryImpl	eventDefinitionNameLike(String nameLike)	Only select event definitions where the name matches the given parameter.
EventDefinitionQueryImpl	eventDefinitionNameLikeIgnoreCase(String nameLikeIgnoreCase)	Only select event definitions where the name matches the given parameter (case-insensitive).
EventDefinitionQueryImpl	eventDefinitionResourceName(String resourceName)	Only select event definition with the given resource name.
EventDefinitionQueryImpl	eventDefinitionResourceNameLike(String resourceNameLike)	Only select event definition with a resource name like the given .
EventDefinitionQueryImpl	eventVersion(Integer version)	Only select event definitions with a certain version.
EventDefinitionQueryImpl	eventVersionGreaterThan(Integer eventVersion)	Only select event definitions which version are greater than a certain version.
EventDefinitionQueryImpl	eventVersionGreaterThanOrEquals(Integer eventVersion)	Only select event definitions which version are greater than or equals a certain version.
EventDefinitionQueryImpl	eventVersionLowerThan(Integer eventVersion)	Only select event definitions which version are lower than a certain version.
EventDefinitionQueryImpl	eventVersionLowerThanOrEquals(Integer eventVersion)	Only select event definitions which version are lower than or equals a certain version.
long	executeCount(CommandContext commandContext)
List<EventDefinition>	executeList(CommandContext commandContext)	Executes the actual query to retrieve the list of results.
String	getCategory()
String	getCategoryLike()
String	getCategoryNotEquals()
String	getDeploymentId()
Set<String>	getDeploymentIds()
String	getId()
Set<String>	getIds()
String	getKey()
String	getKeyLike()
String	getKeyLikeIgnoreCase()
String	getName()
String	getNameLike()
String	getNameLikeIgnoreCase()
String	getParentDeploymentId()
String	getResourceName()
String	getResourceNameLike()
String	getTenantId()
String	getTenantIdLike()
boolean	isWithoutTenantId()
EventDefinitionQueryImpl	latestVersion()	Only select the event definitions which are the latest deployed (ie.
EventDefinitionQuery	orderByDeploymentId()	Order by deployment id (needs to be followed by Query.asc() or Query.desc()).
EventDefinitionQuery	orderByEventDefinitionCategory()	Order by the category of the event definitions (needs to be followed by Query.asc() or Query.desc()).
EventDefinitionQuery	orderByEventDefinitionId()	Order by the id of the event definitions (needs to be followed by Query.asc() or Query.desc()).
EventDefinitionQuery	orderByEventDefinitionKey()	Order by event definition key (needs to be followed by Query.asc() or Query.desc()).
EventDefinitionQuery	orderByEventDefinitionName()	Order by the name of the event definitions (needs to be followed by Query.asc() or Query.desc()).
EventDefinitionQuery	orderByTenantId()	Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
EventDefinitionQueryImpl	parentDeploymentId(String parentDeploymentId)	Only select event definitions that are deployed in a deployment with the given parent deployment id
EventDefinitionQueryImpl	tenantId(String tenantId)	Only select event definitions that have the given tenant id.
EventDefinitionQueryImpl	tenantIdLike(String tenantIdLike)	Only select event definitions with a tenant id like the given one.
EventDefinitionQueryImpl	withoutTenantId()	Only select event definitions that do not have a tenant id.

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

ids

protected Set<String> ids

category

protected String category

categoryLike

protected String categoryLike

categoryNotEquals

protected String categoryNotEquals

name

protected String name

nameLike

protected String nameLike

nameLikeIgnoreCase

protected String nameLikeIgnoreCase

deploymentId

protected String deploymentId

deploymentIds

protected Set<String> deploymentIds

parentDeploymentId

protected String parentDeploymentId

key

protected String key

keyLike

protected String keyLike

keyLikeIgnoreCase

protected String keyLikeIgnoreCase

version

protected Integer version

versionGt

protected Integer versionGt

versionGte

protected Integer versionGte

versionLt

protected Integer versionLt

versionLte

protected Integer versionLte

latest

protected boolean latest

resourceName

protected String resourceName

resourceNameLike

protected String resourceNameLike

tenantId

protected String tenantId

tenantIdLike

protected String tenantIdLike

withoutTenantId

protected boolean withoutTenantId

Constructor Details

EventDefinitionQueryImpl

public EventDefinitionQueryImpl()

EventDefinitionQueryImpl

public EventDefinitionQueryImpl(CommandContext commandContext)

EventDefinitionQueryImpl

public EventDefinitionQueryImpl(CommandExecutor commandExecutor)

Method Details

eventDefinitionId

public EventDefinitionQueryImpl eventDefinitionId(String eventDefinitionId)

Description copied from interface: EventDefinitionQuery

Only select eventdefinition with the given id.

Specified by:

eventDefinitionId in interface EventDefinitionQuery

eventDefinitionIds

public EventDefinitionQueryImpl eventDefinitionIds(Set<String> eventDefinitionIds)

Description copied from interface: EventDefinitionQuery

Only select forms with the given ids.

Specified by:

eventDefinitionIds in interface EventDefinitionQuery

eventCategory

public EventDefinitionQueryImpl eventCategory(String category)

Description copied from interface: EventDefinitionQuery

Only select event definitions with the given category.

Specified by:

eventCategory in interface EventDefinitionQuery

eventCategoryLike

public EventDefinitionQueryImpl eventCategoryLike(String categoryLike)

Description copied from interface: EventDefinitionQuery

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

Specified by:

eventCategoryLike in interface EventDefinitionQuery

eventCategoryNotEquals

public EventDefinitionQueryImpl eventCategoryNotEquals(String categoryNotEquals)

Description copied from interface: EventDefinitionQuery

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

Specified by:

eventCategoryNotEquals in interface EventDefinitionQuery

See Also:

• EventDeploymentBuilder.category(String)

eventDefinitionName

public EventDefinitionQueryImpl eventDefinitionName(String name)

Description copied from interface: EventDefinitionQuery

Only select event definitions with the given name.

Specified by:

eventDefinitionName in interface EventDefinitionQuery

eventDefinitionNameLike

public EventDefinitionQueryImpl eventDefinitionNameLike(String nameLike)

Description copied from interface: EventDefinitionQuery

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

Specified by:

eventDefinitionNameLike in interface EventDefinitionQuery

eventDefinitionNameLikeIgnoreCase

public EventDefinitionQueryImpl eventDefinitionNameLikeIgnoreCase(String nameLikeIgnoreCase)

Description copied from interface: EventDefinitionQuery

Only select event definitions where the name matches the given parameter (case-insensitive). The syntax that should be used is the same as in SQL, eg. %test%

Specified by:

eventDefinitionNameLikeIgnoreCase in interface EventDefinitionQuery

deploymentId

public EventDefinitionQueryImpl deploymentId(String deploymentId)

Description copied from interface: EventDefinitionQuery

Only select event definitions that are deployed in a deployment with the given deployment id

Specified by:

deploymentId in interface EventDefinitionQuery

deploymentIds

public EventDefinitionQueryImpl deploymentIds(Set<String> deploymentIds)

Description copied from interface: EventDefinitionQuery

Select event definitions that are deployed in deployments with the given set of ids

Specified by:

deploymentIds in interface EventDefinitionQuery

parentDeploymentId

public EventDefinitionQueryImpl parentDeploymentId(String parentDeploymentId)

Description copied from interface: EventDefinitionQuery

Only select event definitions that are deployed in a deployment with the given parent deployment id

Specified by:

parentDeploymentId in interface EventDefinitionQuery

eventDefinitionKey

public EventDefinitionQueryImpl eventDefinitionKey(String key)

Description copied from interface: EventDefinitionQuery

Only select event definition with the given key.

Specified by:

eventDefinitionKey in interface EventDefinitionQuery

eventDefinitionKeyLike

public EventDefinitionQueryImpl eventDefinitionKeyLike(String keyLike)

Description copied from interface: EventDefinitionQuery

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

Specified by:

eventDefinitionKeyLike in interface EventDefinitionQuery

eventDefinitionKeyLikeIgnoreCase

public EventDefinitionQueryImpl eventDefinitionKeyLikeIgnoreCase(String keyLikeIgnoreCase)

Description copied from interface: EventDefinitionQuery

Only select event definitions where the key matches the given parameter (case-insensitive). The syntax that should be used is the same as in SQL, eg. %test%

Specified by:

eventDefinitionKeyLikeIgnoreCase in interface EventDefinitionQuery

eventVersion

public EventDefinitionQueryImpl eventVersion(Integer version)

Description copied from interface: EventDefinitionQuery

Only select event definitions with a certain version. Particularly useful when used in combination with EventDefinitionQuery.eventDefinitionKey(String)

Specified by:

eventVersion in interface EventDefinitionQuery

eventVersionGreaterThan

public EventDefinitionQueryImpl eventVersionGreaterThan(Integer eventVersion)

Description copied from interface: EventDefinitionQuery

Only select event definitions which version are greater than a certain version.

Specified by:

eventVersionGreaterThan in interface EventDefinitionQuery

eventVersionGreaterThanOrEquals

public EventDefinitionQueryImpl eventVersionGreaterThanOrEquals(Integer eventVersion)

Description copied from interface: EventDefinitionQuery

Only select event definitions which version are greater than or equals a certain version.

Specified by:

eventVersionGreaterThanOrEquals in interface EventDefinitionQuery

eventVersionLowerThan

public EventDefinitionQueryImpl eventVersionLowerThan(Integer eventVersion)

Description copied from interface: EventDefinitionQuery

Only select event definitions which version are lower than a certain version.

Specified by:

eventVersionLowerThan in interface EventDefinitionQuery

eventVersionLowerThanOrEquals

public EventDefinitionQueryImpl eventVersionLowerThanOrEquals(Integer eventVersion)

Description copied from interface: EventDefinitionQuery

Only select event definitions which version are lower than or equals a certain version.

Specified by:

eventVersionLowerThanOrEquals in interface EventDefinitionQuery

checkVersion

protected void checkVersion(Integer version)

latestVersion

public EventDefinitionQueryImpl latestVersion()

Description copied from interface: EventDefinitionQuery

Only select the event definitions which are the latest deployed (ie. which have the highest version number for the given key). Can also be used without any other criteria (ie. query.latestVersion().list()), which will then give all the latest versions of all the deployed event definitions.

Specified by:

latestVersion in interface EventDefinitionQuery

eventDefinitionResourceName

public EventDefinitionQueryImpl eventDefinitionResourceName(String resourceName)

Description copied from interface: EventDefinitionQuery

Only select event definition with the given resource name.

Specified by:

eventDefinitionResourceName in interface EventDefinitionQuery

eventDefinitionResourceNameLike

public EventDefinitionQueryImpl eventDefinitionResourceNameLike(String resourceNameLike)

Description copied from interface: EventDefinitionQuery

Only select event definition with a resource name like the given .

Specified by:

eventDefinitionResourceNameLike in interface EventDefinitionQuery

tenantId

public EventDefinitionQueryImpl tenantId(String tenantId)

Description copied from interface: EventDefinitionQuery

Only select event definitions that have the given tenant id.

Specified by:

tenantId in interface EventDefinitionQuery

tenantIdLike

public EventDefinitionQueryImpl tenantIdLike(String tenantIdLike)

Description copied from interface: EventDefinitionQuery

Only select event definitions with a tenant id like the given one.

Specified by:

tenantIdLike in interface EventDefinitionQuery

withoutTenantId

public EventDefinitionQueryImpl withoutTenantId()

Description copied from interface: EventDefinitionQuery

Only select event definitions that do not have a tenant id.

Specified by:

withoutTenantId in interface EventDefinitionQuery

orderByDeploymentId

public EventDefinitionQuery orderByDeploymentId()

Description copied from interface: EventDefinitionQuery

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

Specified by:

orderByDeploymentId in interface EventDefinitionQuery

orderByEventDefinitionKey

public EventDefinitionQuery orderByEventDefinitionKey()

Description copied from interface: EventDefinitionQuery

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

Specified by:

orderByEventDefinitionKey in interface EventDefinitionQuery

orderByEventDefinitionCategory

public EventDefinitionQuery orderByEventDefinitionCategory()

Description copied from interface: EventDefinitionQuery

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

Specified by:

orderByEventDefinitionCategory in interface EventDefinitionQuery

orderByEventDefinitionId

public EventDefinitionQuery orderByEventDefinitionId()

Description copied from interface: EventDefinitionQuery

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

Specified by:

orderByEventDefinitionId in interface EventDefinitionQuery

orderByEventDefinitionName

public EventDefinitionQuery orderByEventDefinitionName()

Description copied from interface: EventDefinitionQuery

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

Specified by:

orderByEventDefinitionName in interface EventDefinitionQuery

orderByTenantId

public EventDefinitionQuery orderByTenantId()

Description copied from interface: EventDefinitionQuery

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

Specified by:

orderByTenantId in interface EventDefinitionQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<EventDefinitionQuery,EventDefinition>

executeList

public List<EventDefinition> executeList(CommandContext commandContext)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<EventDefinitionQuery,EventDefinition>

getDeploymentId

public String getDeploymentId()

getDeploymentIds

public Set<String> getDeploymentIds()

getParentDeploymentId

public String getParentDeploymentId()

getId

public String getId()

getIds

public Set<String> getIds()

getName

public String getName()

getNameLike

public String getNameLike()

getNameLikeIgnoreCase

public String getNameLikeIgnoreCase()

getKey

public String getKey()

getKeyLike

public String getKeyLike()

getKeyLikeIgnoreCase

public String getKeyLikeIgnoreCase()

getCategory

public String getCategory()

getCategoryLike

public String getCategoryLike()

getResourceName

public String getResourceName()

getResourceNameLike

public String getResourceNameLike()

getCategoryNotEquals

public String getCategoryNotEquals()

getTenantId

public String getTenantId()

getTenantIdLike

public String getTenantIdLike()

isWithoutTenantId

public boolean isWithoutTenantId()