Package org.flowable.engine.impl
Class ProcessDefinitionQueryImpl
java.lang.Object
org.flowable.common.engine.impl.db.ListQueryParameterObject
org.flowable.common.engine.impl.query.AbstractQuery<ProcessDefinitionQuery,ProcessDefinition>
org.flowable.engine.impl.ProcessDefinitionQueryImpl
- All Implemented Interfaces:
Serializable,Query<ProcessDefinitionQuery,,ProcessDefinition> Command<Object>,ProcessDefinitionQuery
public class ProcessDefinitionQueryImpl
extends AbstractQuery<ProcessDefinitionQuery,ProcessDefinition>
implements ProcessDefinitionQuery
- Author:
- Tom Baeyens, Joram Barrez, Daniel Meyer, Saeid Mirzaei
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultTypeNested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
Query.NullHandlingOnOrder -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Collection<String>protected booleanprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected booleanprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected SuspensionStateprotected Stringprotected Stringprotected Integerprotected Integerprotected Integerprotected Integerprotected Integerprotected booleanprotected booleanFields inherited from class org.flowable.common.engine.impl.query.AbstractQuery
commandContext, commandExecutorFields 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
ConstructorsConstructorDescriptionProcessDefinitionQueryImpl(CommandContext commandContext) ProcessDefinitionQueryImpl(CommandExecutor commandExecutor) -
Method Summary
Modifier and TypeMethodDescriptionactive()Only selects process definitions which are activeprotected voidcheckVersion(Integer version) deploymentId(String deploymentId) Only select process definitions that are deployed in a deployment with the given deployment iddeploymentIds(Set<String> deploymentIds) Select process definitions that are deployed in deployments with the given set of idseventSubscription(String eventType, String eventName) longexecuteCount(CommandContext commandContext) executeList(CommandContext commandContext) Executes the actual query to retrieve the list of results.getId()getIds()getKey()getName()booleanbooleanisLatest()booleanOnly select the process definitions which are the latest deployed (ie.Localize process definition name and description to specified locale.messageEventSubscription(String messageName) messageEventSubscriptionName(String messageName) Selects the single process definition which has a start message event with the messageName.Order by deployment id (needs to be followed byQuery.asc()orQuery.desc()).Order by the category of the process definitions (needs to be followed byQuery.asc()orQuery.desc()).Order by the id of the process definitions (needs to be followed byQuery.asc()orQuery.desc()).Order by process definition key (needs to be followed byQuery.asc()orQuery.desc()).Order by the name of the process definitions (needs to be followed byQuery.asc()orQuery.desc()).Order by the version of the process definitions (needs to be followed byQuery.asc()orQuery.desc()).Order by tenant id (needs to be followed byQuery.asc()orQuery.desc()).parentDeploymentId(String parentDeploymentId) Only select process definitions that are deployed in a deployment with the given parent deployment idprocessDefinitionCategory(String category) Only select process definitions with the given category.processDefinitionCategoryLike(String categoryLike) Only select process definitions where the category matches the given parameter.processDefinitionCategoryNotEquals(String categoryNotEquals) Only select deployments that have a different category then the given one.processDefinitionEngineVersion(String engineVersion) Only select process definitions that have the given engine version.processDefinitionId(String processDefinitionId) Only select process definition with the given id.processDefinitionIds(Set<String> processDefinitionIds) Only select process definitions with the given ids.Only select process definition with the given key.processDefinitionKeyLike(String keyLike) Only select process definitions where the key matches the given parameter.processDefinitionName(String name) Only select process definitions with the given name.processDefinitionNameLike(String nameLike) Only select process definitions where the name matches the given parameter.processDefinitionNameLikeIgnoreCase(String nameLikeIgnoreCase) Only select process definitions where the name matches the given parameter, ignoring upper/lower case.processDefinitionResourceName(String resourceName) Only select process definition with the given resource name.processDefinitionResourceNameLike(String resourceNameLike) Only select process definition with a resource name like the given .processDefinitionStarter(String procDefId) processDefinitionTenantId(String tenantId) Only select process definitions that have the given tenant id.processDefinitionTenantIdLike(String tenantIdLike) Only select process definitions with a tenant id like the given one.processDefinitionVersion(Integer version) Only select process definition with a certain version.processDefinitionVersionGreaterThan(Integer processDefinitionVersion) Only select process definitions which version are greater than a certain version.processDefinitionVersionGreaterThanOrEquals(Integer processDefinitionVersion) Only select process definitions which version are greater than or equals a certain version.processDefinitionVersionLowerThan(Integer processDefinitionVersion) Only select process definitions which version are lower than a certain version.processDefinitionVersionLowerThanOrEquals(Integer processDefinitionVersion) Only select process definitions which version are lower than or equals a certain version.Only select process definitions that do not have a tenant id.voidsetSafeAuthorizationGroups(List<List<String>> safeAuthorizationGroups) voidsetSuspensionState(SuspensionState suspensionState) startableByUser(String userId) Only selects process definitions which given userId is authorized to startstartableByUserOrGroups(String userId, Collection<String> groups) Only selects process definition which the given userId or groups are authorized to start.Only selects process definitions which are suspendedInstruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery
asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, list, listPage, orderBy, orderBy, setCommandExecutor, singleResultMethods 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
-
Field Details
-
id
-
ids
-
category
-
categoryLike
-
categoryNotEquals
-
name
-
nameLike
-
nameLikeIgnoreCase
-
deploymentId
-
deploymentIds
-
parentDeploymentId
-
key
-
keyLike
-
resourceName
-
resourceNameLike
-
version
-
versionGt
-
versionGte
-
versionLt
-
versionLte
-
latest
protected boolean latest -
suspensionState
-
authorizationUserId
-
authorizationGroups
-
authorizationGroupsSet
protected boolean authorizationGroupsSet -
procDefId
-
tenantId
-
tenantIdLike
-
withoutTenantId
protected boolean withoutTenantId -
engineVersion
-
locale
-
withLocalizationFallback
protected boolean withLocalizationFallback -
eventSubscriptionName
-
eventSubscriptionType
-
-
Constructor Details
-
ProcessDefinitionQueryImpl
public ProcessDefinitionQueryImpl() -
ProcessDefinitionQueryImpl
-
ProcessDefinitionQueryImpl
-
-
Method Details
-
processDefinitionId
Description copied from interface:ProcessDefinitionQueryOnly select process definition with the given id.- Specified by:
processDefinitionIdin interfaceProcessDefinitionQuery
-
processDefinitionIds
Description copied from interface:ProcessDefinitionQueryOnly select process definitions with the given ids.- Specified by:
processDefinitionIdsin interfaceProcessDefinitionQuery
-
processDefinitionCategory
Description copied from interface:ProcessDefinitionQueryOnly select process definitions with the given category.- Specified by:
processDefinitionCategoryin interfaceProcessDefinitionQuery
-
processDefinitionCategoryLike
Description copied from interface:ProcessDefinitionQueryOnly select process definitions where the category matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%- Specified by:
processDefinitionCategoryLikein interfaceProcessDefinitionQuery
-
processDefinitionCategoryNotEquals
Description copied from interface:ProcessDefinitionQueryOnly select deployments that have a different category then the given one.- Specified by:
processDefinitionCategoryNotEqualsin interfaceProcessDefinitionQuery- See Also:
-
processDefinitionName
Description copied from interface:ProcessDefinitionQueryOnly select process definitions with the given name.- Specified by:
processDefinitionNamein interfaceProcessDefinitionQuery
-
processDefinitionNameLike
Description copied from interface:ProcessDefinitionQueryOnly select process definitions where the name matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%- Specified by:
processDefinitionNameLikein interfaceProcessDefinitionQuery
-
processDefinitionNameLikeIgnoreCase
Description copied from interface:ProcessDefinitionQueryOnly select process definitions where the name matches the given parameter, ignoring upper/lower case. The syntax that should be used is the same as in SQL, eg. %test%- Specified by:
processDefinitionNameLikeIgnoreCasein interfaceProcessDefinitionQuery
-
deploymentId
Description copied from interface:ProcessDefinitionQueryOnly select process definitions that are deployed in a deployment with the given deployment id- Specified by:
deploymentIdin interfaceProcessDefinitionQuery
-
deploymentIds
Description copied from interface:ProcessDefinitionQuerySelect process definitions that are deployed in deployments with the given set of ids- Specified by:
deploymentIdsin interfaceProcessDefinitionQuery
-
parentDeploymentId
Description copied from interface:ProcessDefinitionQueryOnly select process definitions that are deployed in a deployment with the given parent deployment id- Specified by:
parentDeploymentIdin interfaceProcessDefinitionQuery
-
processDefinitionKey
Description copied from interface:ProcessDefinitionQueryOnly select process definition with the given key.- Specified by:
processDefinitionKeyin interfaceProcessDefinitionQuery
-
processDefinitionKeyLike
Description copied from interface:ProcessDefinitionQueryOnly select process definitions where the key matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%- Specified by:
processDefinitionKeyLikein interfaceProcessDefinitionQuery
-
processDefinitionResourceName
Description copied from interface:ProcessDefinitionQueryOnly select process definition with the given resource name.- Specified by:
processDefinitionResourceNamein interfaceProcessDefinitionQuery
-
processDefinitionResourceNameLike
Description copied from interface:ProcessDefinitionQueryOnly select process definition with a resource name like the given .- Specified by:
processDefinitionResourceNameLikein interfaceProcessDefinitionQuery
-
processDefinitionVersion
Description copied from interface:ProcessDefinitionQueryOnly select process definition with a certain version. Particularly useful when used in combination withProcessDefinitionQuery.processDefinitionKey(String)- Specified by:
processDefinitionVersionin interfaceProcessDefinitionQuery
-
processDefinitionVersionGreaterThan
Description copied from interface:ProcessDefinitionQueryOnly select process definitions which version are greater than a certain version.- Specified by:
processDefinitionVersionGreaterThanin interfaceProcessDefinitionQuery
-
processDefinitionVersionGreaterThanOrEquals
public ProcessDefinitionQuery processDefinitionVersionGreaterThanOrEquals(Integer processDefinitionVersion) Description copied from interface:ProcessDefinitionQueryOnly select process definitions which version are greater than or equals a certain version.- Specified by:
processDefinitionVersionGreaterThanOrEqualsin interfaceProcessDefinitionQuery
-
processDefinitionVersionLowerThan
Description copied from interface:ProcessDefinitionQueryOnly select process definitions which version are lower than a certain version.- Specified by:
processDefinitionVersionLowerThanin interfaceProcessDefinitionQuery
-
processDefinitionVersionLowerThanOrEquals
public ProcessDefinitionQuery processDefinitionVersionLowerThanOrEquals(Integer processDefinitionVersion) Description copied from interface:ProcessDefinitionQueryOnly select process definitions which version are lower than or equals a certain version.- Specified by:
processDefinitionVersionLowerThanOrEqualsin interfaceProcessDefinitionQuery
-
checkVersion
-
latestVersion
Description copied from interface:ProcessDefinitionQueryOnly select the process 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.latest().list()), which will then give all the latest versions of all the deployed process definitions.- Specified by:
latestVersionin interfaceProcessDefinitionQuery
-
active
Description copied from interface:ProcessDefinitionQueryOnly selects process definitions which are active- Specified by:
activein interfaceProcessDefinitionQuery
-
suspended
Description copied from interface:ProcessDefinitionQueryOnly selects process definitions which are suspended- Specified by:
suspendedin interfaceProcessDefinitionQuery
-
processDefinitionTenantId
Description copied from interface:ProcessDefinitionQueryOnly select process definitions that have the given tenant id.- Specified by:
processDefinitionTenantIdin interfaceProcessDefinitionQuery
-
processDefinitionTenantIdLike
Description copied from interface:ProcessDefinitionQueryOnly select process definitions with a tenant id like the given one.- Specified by:
processDefinitionTenantIdLikein interfaceProcessDefinitionQuery
-
processDefinitionWithoutTenantId
Description copied from interface:ProcessDefinitionQueryOnly select process definitions that do not have a tenant id.- Specified by:
processDefinitionWithoutTenantIdin interfaceProcessDefinitionQuery
-
processDefinitionEngineVersion
Description copied from interface:ProcessDefinitionQueryOnly select process definitions that have the given engine version.- Specified by:
processDefinitionEngineVersionin interfaceProcessDefinitionQuery
-
messageEventSubscription
-
messageEventSubscriptionName
Description copied from interface:ProcessDefinitionQuerySelects the single process definition which has a start message event with the messageName.- Specified by:
messageEventSubscriptionNamein interfaceProcessDefinitionQuery
-
locale
Description copied from interface:ProcessDefinitionQueryLocalize process definition name and description to specified locale.- Specified by:
localein interfaceProcessDefinitionQuery
-
withLocalizationFallback
Description copied from interface:ProcessDefinitionQueryInstruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.- Specified by:
withLocalizationFallbackin interfaceProcessDefinitionQuery
-
processDefinitionStarter
-
eventSubscription
-
getAuthorizationGroups
-
startableByUser
Description copied from interface:ProcessDefinitionQueryOnly selects process definitions which given userId is authorized to start- Specified by:
startableByUserin interfaceProcessDefinitionQuery
-
startableByUserOrGroups
Description copied from interface:ProcessDefinitionQueryOnly selects process definition which the given userId or groups are authorized to start.- Specified by:
startableByUserOrGroupsin interfaceProcessDefinitionQuery
-
orderByDeploymentId
Description copied from interface:ProcessDefinitionQueryOrder by deployment id (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByDeploymentIdin interfaceProcessDefinitionQuery
-
orderByProcessDefinitionKey
Description copied from interface:ProcessDefinitionQueryOrder by process definition key (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByProcessDefinitionKeyin interfaceProcessDefinitionQuery
-
orderByProcessDefinitionCategory
Description copied from interface:ProcessDefinitionQueryOrder by the category of the process definitions (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByProcessDefinitionCategoryin interfaceProcessDefinitionQuery
-
orderByProcessDefinitionId
Description copied from interface:ProcessDefinitionQueryOrder by the id of the process definitions (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByProcessDefinitionIdin interfaceProcessDefinitionQuery
-
orderByProcessDefinitionVersion
Description copied from interface:ProcessDefinitionQueryOrder by the version of the process definitions (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByProcessDefinitionVersionin interfaceProcessDefinitionQuery
-
orderByProcessDefinitionName
Description copied from interface:ProcessDefinitionQueryOrder by the name of the process definitions (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByProcessDefinitionNamein interfaceProcessDefinitionQuery
-
orderByTenantId
Description copied from interface:ProcessDefinitionQueryOrder by tenant id (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByTenantIdin interfaceProcessDefinitionQuery
-
executeCount
- Specified by:
executeCountin classAbstractQuery<ProcessDefinitionQuery,ProcessDefinition>
-
executeList
Description copied from class:AbstractQueryExecutes the actual query to retrieve the list of results.- Specified by:
executeListin classAbstractQuery<ProcessDefinitionQuery,ProcessDefinition>
-
getDeploymentId
-
getDeploymentIds
-
getParentDeploymentId
-
getId
-
getIds
-
getName
-
getNameLike
-
getNameLikeIgnoreCase
-
getKey
-
getKeyLike
-
getVersion
-
getVersionGt
-
getVersionGte
-
getVersionLt
-
getVersionLte
-
isLatest
public boolean isLatest() -
getCategory
-
getCategoryLike
-
getResourceName
-
getResourceNameLike
-
getSuspensionState
-
setSuspensionState
-
getCategoryNotEquals
-
getTenantId
-
getTenantIdLike
-
isWithoutTenantId
public boolean isWithoutTenantId() -
getEngineVersion
-
getAuthorizationUserId
-
getProcDefId
-
getEventSubscriptionName
-
getEventSubscriptionType
-
isIncludeAuthorization
public boolean isIncludeAuthorization() -
getSafeAuthorizationGroups
-
setSafeAuthorizationGroups
-