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
,org.flowable.common.engine.api.query.Query<ProcessDefinitionQuery,
,ProcessDefinition> org.flowable.common.engine.impl.interceptor.Command<Object>
,ProcessDefinitionQuery
public class ProcessDefinitionQueryImpl
extends org.flowable.common.engine.impl.query.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
org.flowable.common.engine.impl.db.ListQueryParameterObject.OrderBy, org.flowable.common.engine.impl.db.ListQueryParameterObject.ResultType
Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
org.flowable.common.engine.api.query.Query.NullHandlingOnOrder
-
Field Summary
Modifier and TypeFieldDescriptionprotected Collection<String>
protected boolean
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected boolean
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected org.flowable.common.engine.impl.db.SuspensionState
protected String
protected String
protected Integer
protected Integer
protected Integer
protected Integer
protected Integer
protected boolean
protected boolean
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
ConstructorDescriptionProcessDefinitionQueryImpl
(org.flowable.common.engine.impl.interceptor.CommandContext commandContext) ProcessDefinitionQueryImpl
(org.flowable.common.engine.impl.interceptor.CommandExecutor commandExecutor) -
Method Summary
Modifier and TypeMethodDescriptionactive()
Only selects process definitions which are activeprotected void
checkVersion
(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) long
executeCount
(org.flowable.common.engine.impl.interceptor.CommandContext commandContext) executeList
(org.flowable.common.engine.impl.interceptor.CommandContext commandContext) getId()
getIds()
getKey()
getName()
org.flowable.common.engine.impl.db.SuspensionState
boolean
boolean
isLatest()
boolean
Only select the process definitions which are the latest deployed (ie. which have the highest version number for the given key).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.void
setSafeAuthorizationGroups
(List<List<String>> safeAuthorizationGroups) void
setSuspensionState
(org.flowable.common.engine.impl.db.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, 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
-
ids
-
category
-
categoryLike
-
categoryNotEquals
-
name
-
nameLike
-
nameLikeIgnoreCase
-
deploymentId
-
deploymentIds
-
parentDeploymentId
-
key
-
keyLike
-
resourceName
-
resourceNameLike
-
version
-
versionGt
-
versionGte
-
versionLt
-
versionLte
-
latest
protected boolean latest -
suspensionState
protected org.flowable.common.engine.impl.db.SuspensionState 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
public ProcessDefinitionQueryImpl(org.flowable.common.engine.impl.interceptor.CommandContext commandContext) -
ProcessDefinitionQueryImpl
public ProcessDefinitionQueryImpl(org.flowable.common.engine.impl.interceptor.CommandExecutor commandExecutor)
-
-
Method Details
-
processDefinitionId
Description copied from interface:ProcessDefinitionQuery
Only select process definition with the given id.- Specified by:
processDefinitionId
in interfaceProcessDefinitionQuery
-
processDefinitionIds
Description copied from interface:ProcessDefinitionQuery
Only select process definitions with the given ids.- Specified by:
processDefinitionIds
in interfaceProcessDefinitionQuery
-
processDefinitionCategory
Description copied from interface:ProcessDefinitionQuery
Only select process definitions with the given category.- Specified by:
processDefinitionCategory
in interfaceProcessDefinitionQuery
-
processDefinitionCategoryLike
Description copied from interface:ProcessDefinitionQuery
Only 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:
processDefinitionCategoryLike
in interfaceProcessDefinitionQuery
-
processDefinitionCategoryNotEquals
Description copied from interface:ProcessDefinitionQuery
Only select deployments that have a different category then the given one.- Specified by:
processDefinitionCategoryNotEquals
in interfaceProcessDefinitionQuery
- See Also:
-
processDefinitionName
Description copied from interface:ProcessDefinitionQuery
Only select process definitions with the given name.- Specified by:
processDefinitionName
in interfaceProcessDefinitionQuery
-
processDefinitionNameLike
Description copied from interface:ProcessDefinitionQuery
Only 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:
processDefinitionNameLike
in interfaceProcessDefinitionQuery
-
processDefinitionNameLikeIgnoreCase
Description copied from interface:ProcessDefinitionQuery
Only 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:
processDefinitionNameLikeIgnoreCase
in interfaceProcessDefinitionQuery
-
deploymentId
Description copied from interface:ProcessDefinitionQuery
Only select process definitions that are deployed in a deployment with the given deployment id- Specified by:
deploymentId
in interfaceProcessDefinitionQuery
-
deploymentIds
Description copied from interface:ProcessDefinitionQuery
Select process definitions that are deployed in deployments with the given set of ids- Specified by:
deploymentIds
in interfaceProcessDefinitionQuery
-
parentDeploymentId
Description copied from interface:ProcessDefinitionQuery
Only select process definitions that are deployed in a deployment with the given parent deployment id- Specified by:
parentDeploymentId
in interfaceProcessDefinitionQuery
-
processDefinitionKey
Description copied from interface:ProcessDefinitionQuery
Only select process definition with the given key.- Specified by:
processDefinitionKey
in interfaceProcessDefinitionQuery
-
processDefinitionKeyLike
Description copied from interface:ProcessDefinitionQuery
Only 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:
processDefinitionKeyLike
in interfaceProcessDefinitionQuery
-
processDefinitionResourceName
Description copied from interface:ProcessDefinitionQuery
Only select process definition with the given resource name.- Specified by:
processDefinitionResourceName
in interfaceProcessDefinitionQuery
-
processDefinitionResourceNameLike
Description copied from interface:ProcessDefinitionQuery
Only select process definition with a resource name like the given .- Specified by:
processDefinitionResourceNameLike
in interfaceProcessDefinitionQuery
-
processDefinitionVersion
Description copied from interface:ProcessDefinitionQuery
Only select process definition with a certain version. Particularly useful when used in combination withProcessDefinitionQuery.processDefinitionKey(String)
- Specified by:
processDefinitionVersion
in interfaceProcessDefinitionQuery
-
processDefinitionVersionGreaterThan
Description copied from interface:ProcessDefinitionQuery
Only select process definitions which version are greater than a certain version.- Specified by:
processDefinitionVersionGreaterThan
in interfaceProcessDefinitionQuery
-
processDefinitionVersionGreaterThanOrEquals
public ProcessDefinitionQuery processDefinitionVersionGreaterThanOrEquals(Integer processDefinitionVersion) Description copied from interface:ProcessDefinitionQuery
Only select process definitions which version are greater than or equals a certain version.- Specified by:
processDefinitionVersionGreaterThanOrEquals
in interfaceProcessDefinitionQuery
-
processDefinitionVersionLowerThan
Description copied from interface:ProcessDefinitionQuery
Only select process definitions which version are lower than a certain version.- Specified by:
processDefinitionVersionLowerThan
in interfaceProcessDefinitionQuery
-
processDefinitionVersionLowerThanOrEquals
public ProcessDefinitionQuery processDefinitionVersionLowerThanOrEquals(Integer processDefinitionVersion) Description copied from interface:ProcessDefinitionQuery
Only select process definitions which version are lower than or equals a certain version.- Specified by:
processDefinitionVersionLowerThanOrEquals
in interfaceProcessDefinitionQuery
-
checkVersion
-
latestVersion
Description copied from interface:ProcessDefinitionQuery
Only 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:
latestVersion
in interfaceProcessDefinitionQuery
-
active
Description copied from interface:ProcessDefinitionQuery
Only selects process definitions which are active- Specified by:
active
in interfaceProcessDefinitionQuery
-
suspended
Description copied from interface:ProcessDefinitionQuery
Only selects process definitions which are suspended- Specified by:
suspended
in interfaceProcessDefinitionQuery
-
processDefinitionTenantId
Description copied from interface:ProcessDefinitionQuery
Only select process definitions that have the given tenant id.- Specified by:
processDefinitionTenantId
in interfaceProcessDefinitionQuery
-
processDefinitionTenantIdLike
Description copied from interface:ProcessDefinitionQuery
Only select process definitions with a tenant id like the given one.- Specified by:
processDefinitionTenantIdLike
in interfaceProcessDefinitionQuery
-
processDefinitionWithoutTenantId
Description copied from interface:ProcessDefinitionQuery
Only select process definitions that do not have a tenant id.- Specified by:
processDefinitionWithoutTenantId
in interfaceProcessDefinitionQuery
-
processDefinitionEngineVersion
Description copied from interface:ProcessDefinitionQuery
Only select process definitions that have the given engine version.- Specified by:
processDefinitionEngineVersion
in interfaceProcessDefinitionQuery
-
messageEventSubscription
-
messageEventSubscriptionName
Description copied from interface:ProcessDefinitionQuery
Selects the single process definition which has a start message event with the messageName.- Specified by:
messageEventSubscriptionName
in interfaceProcessDefinitionQuery
-
locale
Description copied from interface:ProcessDefinitionQuery
Localize process definition name and description to specified locale.- Specified by:
locale
in interfaceProcessDefinitionQuery
-
withLocalizationFallback
Description copied from interface:ProcessDefinitionQuery
Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.- Specified by:
withLocalizationFallback
in interfaceProcessDefinitionQuery
-
processDefinitionStarter
-
eventSubscription
-
getAuthorizationGroups
-
startableByUser
Description copied from interface:ProcessDefinitionQuery
Only selects process definitions which given userId is authorized to start- Specified by:
startableByUser
in interfaceProcessDefinitionQuery
-
startableByUserOrGroups
Description copied from interface:ProcessDefinitionQuery
Only selects process definition which the given userId or groups are authorized to start.- Specified by:
startableByUserOrGroups
in interfaceProcessDefinitionQuery
-
orderByDeploymentId
Description copied from interface:ProcessDefinitionQuery
Order by deployment id (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByDeploymentId
in interfaceProcessDefinitionQuery
-
orderByProcessDefinitionKey
Description copied from interface:ProcessDefinitionQuery
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessDefinitionKey
in interfaceProcessDefinitionQuery
-
orderByProcessDefinitionCategory
Description copied from interface:ProcessDefinitionQuery
Order by the category of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessDefinitionCategory
in interfaceProcessDefinitionQuery
-
orderByProcessDefinitionId
Description copied from interface:ProcessDefinitionQuery
Order by the id of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessDefinitionId
in interfaceProcessDefinitionQuery
-
orderByProcessDefinitionVersion
Description copied from interface:ProcessDefinitionQuery
Order by the version of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessDefinitionVersion
in interfaceProcessDefinitionQuery
-
orderByProcessDefinitionName
Description copied from interface:ProcessDefinitionQuery
Order by the name of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessDefinitionName
in interfaceProcessDefinitionQuery
-
orderByTenantId
Description copied from interface:ProcessDefinitionQuery
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByTenantId
in interfaceProcessDefinitionQuery
-
executeCount
public long executeCount(org.flowable.common.engine.impl.interceptor.CommandContext commandContext) - Specified by:
executeCount
in classorg.flowable.common.engine.impl.query.AbstractQuery<ProcessDefinitionQuery,
ProcessDefinition>
-
executeList
public List<ProcessDefinition> executeList(org.flowable.common.engine.impl.interceptor.CommandContext commandContext) - Specified by:
executeList
in classorg.flowable.common.engine.impl.query.AbstractQuery<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
public org.flowable.common.engine.impl.db.SuspensionState getSuspensionState() -
setSuspensionState
public void setSuspensionState(org.flowable.common.engine.impl.db.SuspensionState suspensionState) -
getCategoryNotEquals
-
getTenantId
-
getTenantIdLike
-
isWithoutTenantId
public boolean isWithoutTenantId() -
getEngineVersion
-
getAuthorizationUserId
-
getProcDefId
-
getEventSubscriptionName
-
getEventSubscriptionType
-
isIncludeAuthorization
public boolean isIncludeAuthorization() -
getSafeAuthorizationGroups
-
setSafeAuthorizationGroups
-