Interface ProcessDefinitionQuery
- All Superinterfaces:
Query<ProcessDefinitionQuery,
ProcessDefinition>
- All Known Implementing Classes:
ProcessDefinitionQueryImpl
Allows programmatic querying of
ProcessDefinition
s.- Author:
- Tom Baeyens, Joram Barrez, Daniel Meyer, Saeid Mirzaei
-
Method Summary
Modifier and TypeMethodDescriptionactive()
Only selects process definitions which are activedeployedAfter
(Date deployedAfter) Only select process definitions that were deployed after the given Date (exclusive).deployedAt
(Date deployedAt) Only select process definitions that were deployed at the given Date.deploymentId
(String deploymentId) Only select process definitions that are deployed in a deployment with the given deployment idincidentId
(String incidentId) Only selects process definitions with the given incident id.incidentMessage
(String incidentMessage) Only selects process definitions with the given incident message.incidentMessageLike
(String incidentMessageLike) Only selects process definitions with an incident message like the given.incidentType
(String incidentType) Only selects process definitions with the given incident type.Select process definitions which have no tenant id.Only select the process definitions which are the latest deployed (ie.messageEventSubscription
(String messageName) Deprecated.messageEventSubscriptionName
(String messageName) Selects the single process definition which has a start message event with the messageName.Select process definitions which could not be started in Tasklist.Order by deployment id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by deployment time (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()
).Order by version tag (needs to be followed byQuery.asc()
orQuery.desc()
).processDefinitionCategory
(String processDefinitionCategory) Only select process definitions with the given category.processDefinitionCategoryLike
(String processDefinitionCategoryLike) Only select process definitions where the category matches the given parameter.processDefinitionId
(String processDefinitionId) Only select process definition with the given id.processDefinitionIdIn
(String... ids) Only select process definition with the given id.processDefinitionKey
(String processDefinitionKey) Only select process definition with the given key.processDefinitionKeyIn
(String... processDefinitionKeys) Only select process definitions with the given keys.processDefinitionKeyLike
(String processDefinitionKeyLike) Only select process definitions where the key matches the given parameter.processDefinitionKeysIn
(String... processDefinitionKeys) Deprecated.processDefinitionName
(String processDefinitionName) Only select process definitions with the given name.processDefinitionNameLike
(String processDefinitionNameLike) Only select process definitions where the name matches the given parameter.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 .processDefinitionVersion
(Integer processDefinitionVersion) Only select process definition with a certain version.startableByUser
(String userId) Only selects process definitions which given userId is authorized to startSelect process definitions which could be started in Tasklist.Only selects process definitions which are suspendedtenantIdIn
(String... tenantIds) Only select process definitions with one of the given tenant ids.versionTag
(String versionTag) Only selects process definitions with a specific version tagversionTagLike
(String versionTagLike) Only selects process definitions with a version tag like the givenOnly select process definitions which have no tenant id.Only selects process definitions without a version tagMethods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
Method Details
-
processDefinitionId
Only select process definition with the given id. -
processDefinitionIdIn
Only select process definition with the given id. -
processDefinitionCategory
Only select process definitions with the given category. -
processDefinitionCategoryLike
Only select process definitions where the category matches the given parameter. The syntax that should be used is the same as in SQL, eg. %activiti% -
processDefinitionName
Only select process definitions with the given name. -
processDefinitionNameLike
Only select process definitions where the name matches the given parameter. The syntax that should be used is the same as in SQL, eg. %activiti% -
deploymentId
Only select process definitions that are deployed in a deployment with the given deployment id -
deployedAfter
Only select process definitions that were deployed after the given Date (exclusive). -
deployedAt
Only select process definitions that were deployed at the given Date. -
processDefinitionKey
Only select process definition with the given key. -
processDefinitionKeysIn
Deprecated.Only select process definitions with the given keys.Deprecated: use
processDefinitionKeyIn(String...)
-
processDefinitionKeyIn
Only select process definitions with the given keys.- Parameters:
processDefinitionKeys
- keys to look for during query.- Returns:
- query builder.
-
processDefinitionKeyLike
Only select process definitions where the key matches the given parameter. The syntax that should be used is the same as in SQL, eg. %activiti% -
processDefinitionVersion
Only select process definition with a certain version. Particularly useful when used in combination withprocessDefinitionKey(String)
-
latestVersion
ProcessDefinitionQuery latestVersion()Only select the process definitions which are the latest deployed (ie. which have the highest version number for the given key).
Can only be used in combination with
processDefinitionKey(String)
ofprocessDefinitionKeyLike(String)
. 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.For multi-tenancy: select the latest deployed process definitions for each tenant. If a process definition is deployed for multiple tenants then all process definitions are selected.
- Throws:
ProcessEngineException
- if used in combination with#groupId(string)
,#processDefinitionVersion(int)
ordeploymentId(String)
-
processDefinitionResourceName
Only select process definition with the given resource name. -
processDefinitionResourceNameLike
Only select process definition with a resource name like the given . -
startableByUser
Only selects process definitions which given userId is authorized to start -
suspended
ProcessDefinitionQuery suspended()Only selects process definitions which are suspended -
active
ProcessDefinitionQuery active()Only selects process definitions which are active -
incidentType
Only selects process definitions with the given incident type. -
incidentId
Only selects process definitions with the given incident id. -
incidentMessage
Only selects process definitions with the given incident message. -
incidentMessageLike
Only selects process definitions with an incident message like the given. -
versionTag
Only selects process definitions with a specific version tag -
versionTagLike
Only selects process definitions with a version tag like the given -
withoutVersionTag
ProcessDefinitionQuery withoutVersionTag()Only selects process definitions without a version tag -
messageEventSubscription
Deprecated.- See Also:
-
messageEventSubscriptionName
Selects the single process definition which has a start message event with the messageName. -
tenantIdIn
Only select process definitions with one of the given tenant ids. -
withoutTenantId
ProcessDefinitionQuery withoutTenantId()Only select process definitions which have no tenant id. -
includeProcessDefinitionsWithoutTenantId
ProcessDefinitionQuery includeProcessDefinitionsWithoutTenantId()Select process definitions which have no tenant id. Can be used in combination withtenantIdIn(String...)
. -
startableInTasklist
ProcessDefinitionQuery startableInTasklist()Select process definitions which could be started in Tasklist. -
notStartableInTasklist
ProcessDefinitionQuery notStartableInTasklist()Select process definitions which could not be started in Tasklist. -
startablePermissionCheck
ProcessDefinitionQuery startablePermissionCheck() -
orderByProcessDefinitionCategory
ProcessDefinitionQuery orderByProcessDefinitionCategory()Order by the category of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionKey
ProcessDefinitionQuery orderByProcessDefinitionKey()Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionId
ProcessDefinitionQuery orderByProcessDefinitionId()Order by the id of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionVersion
ProcessDefinitionQuery orderByProcessDefinitionVersion()Order by the version of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionName
ProcessDefinitionQuery orderByProcessDefinitionName()Order by the name of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByDeploymentId
ProcessDefinitionQuery orderByDeploymentId()Order by deployment id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByDeploymentTime
ProcessDefinitionQuery orderByDeploymentTime()Order by deployment time (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTenantId
ProcessDefinitionQuery orderByTenantId()Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). Note that the ordering of process instances without tenant id is database-specific. -
orderByVersionTag
ProcessDefinitionQuery orderByVersionTag()Order by version tag (needs to be followed byQuery.asc()
orQuery.desc()
). Note: sorting by versionTag is a string based sort. There is no interpretation of the version which can lead to a sorting like: v0.1.0 v0.10.0 v0.2.0.
-