Uses of Interface
org.camunda.bpm.engine.repository.ProcessDefinitionQuery
Package
Description
Public API of the Camunda Platform engine.
Typical usage of the API starts by the creation of a
Through the services obtained from such a
Typical usage of the API starts by the creation of a
ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine
can be obtained.Through the services obtained from such a
ProcessEngine
, BPM and workflow operation
can be executed:RepositoryService
:
Manages Deployment
sRuntimeService
:
For starting and searching ProcessInstance
sTaskService
:
Exposes operations to manage human (standalone) Task
s,
such as claiming, completing and assigning tasksIdentityService
:
Used for managing User
s,
Group
s and the relations between themManagementService
:
Exposes engine admin and maintenance operations,
which have no relation to the runtime execution of business processesHistoryService
:
Exposes information about ongoing and past process instances.FormService
:
Access to form data and rendered forms for starting new process instances and completing tasks.API implementation classes, which shouldn't directly be used by end-users.
Classes related to the
RepositoryService
.-
Uses of ProcessDefinitionQuery in org.camunda.bpm.engine
Modifier and TypeMethodDescriptionRepositoryService.createProcessDefinitionQuery()
Query process definitions. -
Uses of ProcessDefinitionQuery in org.camunda.bpm.engine.impl
Modifier and TypeMethodDescriptionProcessDefinitionQueryImpl.active()
RepositoryServiceImpl.createProcessDefinitionQuery()
ProcessDefinitionQueryImpl.eventSubscription
(EventType eventType, String eventName) ProcessDefinitionQueryImpl.incidentId
(String incidentId) ProcessDefinitionQueryImpl.incidentMessage
(String incidentMessage) ProcessDefinitionQueryImpl.incidentMessageLike
(String incidentMessageLike) ProcessDefinitionQueryImpl.incidentType
(String incidentType) ProcessDefinitionQueryImpl.includeProcessDefinitionsWithoutTenantId()
ProcessDefinitionQueryImpl.messageEventSubscription
(String messageName) ProcessDefinitionQueryImpl.messageEventSubscriptionName
(String messageName) ProcessDefinitionQueryImpl.notStartableInTasklist()
ProcessDefinitionQueryImpl.orderByDeploymentId()
ProcessDefinitionQueryImpl.orderByDeploymentTime()
ProcessDefinitionQueryImpl.orderByProcessDefinitionCategory()
ProcessDefinitionQueryImpl.orderByProcessDefinitionId()
ProcessDefinitionQueryImpl.orderByProcessDefinitionKey()
ProcessDefinitionQueryImpl.orderByProcessDefinitionName()
ProcessDefinitionQueryImpl.orderByProcessDefinitionVersion()
ProcessDefinitionQueryImpl.orderByTenantId()
ProcessDefinitionQueryImpl.orderByVersionTag()
ProcessDefinitionQueryImpl.processDefinitionStarter
(String procDefId) ProcessDefinitionQueryImpl.startableInTasklist()
ProcessDefinitionQueryImpl.startablePermissionCheck()
ProcessDefinitionQueryImpl.suspended()
ProcessDefinitionQueryImpl.versionTag
(String versionTag) ProcessDefinitionQueryImpl.versionTagLike
(String versionTagLike) ProcessDefinitionQueryImpl.withoutTenantId()
ProcessDefinitionQueryImpl.withoutVersionTag()
-
Uses of ProcessDefinitionQuery in org.camunda.bpm.engine.repository
Modifier and TypeMethodDescriptionProcessDefinitionQuery.active()
Only selects process definitions which are activeProcessDefinitionQuery.deployedAfter
(Date deployedAfter) Only select process definitions that were deployed after the given Date (exclusive).ProcessDefinitionQuery.deployedAt
(Date deployedAt) Only select process definitions that were deployed at the given Date.ProcessDefinitionQuery.deploymentId
(String deploymentId) Only select process definitions that are deployed in a deployment with the given deployment idProcessDefinitionQuery.incidentId
(String incidentId) Only selects process definitions with the given incident id.ProcessDefinitionQuery.incidentMessage
(String incidentMessage) Only selects process definitions with the given incident message.ProcessDefinitionQuery.incidentMessageLike
(String incidentMessageLike) Only selects process definitions with an incident message like the given.ProcessDefinitionQuery.incidentType
(String incidentType) Only selects process definitions with the given incident type.ProcessDefinitionQuery.includeProcessDefinitionsWithoutTenantId()
Select process definitions which have no tenant id.ProcessDefinitionQuery.latestVersion()
Only select the process definitions which are the latest deployed (ie.ProcessDefinitionQuery.messageEventSubscription
(String messageName) Deprecated.ProcessDefinitionQuery.messageEventSubscriptionName
(String messageName) Selects the single process definition which has a start message event with the messageName.ProcessDefinitionQuery.notStartableInTasklist()
Select process definitions which could not be started in Tasklist.ProcessDefinitionQuery.orderByDeploymentId()
Order by deployment id (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessDefinitionQuery.orderByDeploymentTime()
Order by deployment time (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessDefinitionQuery.orderByProcessDefinitionCategory()
Order by the category of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessDefinitionQuery.orderByProcessDefinitionId()
Order by the id of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessDefinitionQuery.orderByProcessDefinitionKey()
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessDefinitionQuery.orderByProcessDefinitionName()
Order by the name of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessDefinitionQuery.orderByProcessDefinitionVersion()
Order by the version of the process definitions (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessDefinitionQuery.orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessDefinitionQuery.orderByVersionTag()
Order by version tag (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessDefinitionQuery.processDefinitionCategory
(String processDefinitionCategory) Only select process definitions with the given category.ProcessDefinitionQuery.processDefinitionCategoryLike
(String processDefinitionCategoryLike) Only select process definitions where the category matches the given parameter.ProcessDefinitionQuery.processDefinitionId
(String processDefinitionId) Only select process definiton with the given id.ProcessDefinitionQuery.processDefinitionIdIn
(String... ids) Only select process definiton with the given id.ProcessDefinitionQuery.processDefinitionKey
(String processDefinitionKey) Only select process definition with the given key.ProcessDefinitionQuery.processDefinitionKeyLike
(String processDefinitionKeyLike) Only select process definitions where the key matches the given parameter.ProcessDefinitionQuery.processDefinitionName
(String processDefinitionName) Only select process definitions with the given name.ProcessDefinitionQuery.processDefinitionNameLike
(String processDefinitionNameLike) Only select process definitions where the name matches the given parameter.ProcessDefinitionQuery.processDefinitionResourceName
(String resourceName) Only select process definition with the given resource name.ProcessDefinitionQuery.processDefinitionResourceNameLike
(String resourceNameLike) Only select process definition with a resource name like the given .ProcessDefinitionQuery.processDefinitionVersion
(Integer processDefinitionVersion) Only select process definition with a certain version.ProcessDefinitionQuery.startableByUser
(String userId) Only selects process definitions which given userId is authorized to startProcessDefinitionQuery.startableInTasklist()
Select process definitions which could be started in Tasklist.ProcessDefinitionQuery.startablePermissionCheck()
ProcessDefinitionQuery.suspended()
Only selects process definitions which are suspendedProcessDefinitionQuery.tenantIdIn
(String... tenantIds) Only select process definitions with one of the given tenant ids.ProcessDefinitionQuery.versionTag
(String versionTag) Only selects process definitions with a specific version tagProcessDefinitionQuery.versionTagLike
(String versionTagLike) Only selects process definitions with a version tag like the givenProcessDefinitionQuery.withoutTenantId()
Only select process definitions which have no tenant id.ProcessDefinitionQuery.withoutVersionTag()
Only selects process definitions without a version tag -
Uses of ProcessDefinitionQuery in org.camunda.bpm.engine.rest.dto.repository
Modifier and TypeMethodDescriptionprotected ProcessDefinitionQuery
ProcessDefinitionQueryDto.createNewQuery
(ProcessEngine engine) Modifier and TypeMethodDescriptionprotected void
ProcessDefinitionQueryDto.applyFilters
(ProcessDefinitionQuery query) protected void
ProcessDefinitionQueryDto.applySortBy
(ProcessDefinitionQuery query, String sortBy, Map<String, Object> parameters, ProcessEngine engine) -
Uses of ProcessDefinitionQuery in org.camunda.bpm.engine.test.assertions.bpmn
Modifier and TypeMethodDescriptionprotected ProcessDefinitionQuery
AbstractProcessAssert.processDefinitionQuery()
static ProcessDefinitionQuery
BpmnAwareTests.processDefinitionQuery()
Helper method to easily create a new ProcessDefinitionQueryprotected ProcessDefinitionQuery
ProcessDefinitionAssert.processDefinitionQuery()
protected ProcessDefinitionQuery
ProcessInstanceAssert.processDefinitionQuery()
Modifier and TypeMethodDescriptionstatic ProcessDefinition
BpmnAwareTests.processDefinition
(ProcessDefinitionQuery processDefinitionQuery) Helper method to easily access the process definition compliant to a given process definition query.