Interface ProcessDefinitionQuery

    • Method Detail

      • processDefinitionId

        ProcessDefinitionQuery processDefinitionId​(String processDefinitionId)
        Only select process definiton with the given id.
      • processDefinitionCategory

        ProcessDefinitionQuery processDefinitionCategory​(String processDefinitionCategory)
        Only select process definitions with the given category.
      • processDefinitionCategoryLike

        ProcessDefinitionQuery processDefinitionCategoryLike​(String 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

        ProcessDefinitionQuery processDefinitionName​(String processDefinitionName)
        Only select process definitions with the given name.
      • processDefinitionNameLike

        ProcessDefinitionQuery processDefinitionNameLike​(String 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

        ProcessDefinitionQuery deploymentId​(String deploymentId)
        Only select process definitions that are deployed in a deployment with the given deployment id
      • deployedAfter

        ProcessDefinitionQuery deployedAfter​(Date deployedAfter)
        Only select process definitions that were deployed after the given Date (exclusive).
      • deployedAt

        ProcessDefinitionQuery deployedAt​(Date deployedAt)
        Only select process definitions that were deployed at the given Date.
      • processDefinitionKey

        ProcessDefinitionQuery processDefinitionKey​(String processDefinitionKey)
        Only select process definition with the given key.
      • processDefinitionKeysIn

        ProcessDefinitionQueryImpl processDefinitionKeysIn​(String... processDefinitionKeys)
        Only select process definitions with the given keys
      • processDefinitionKeyLike

        ProcessDefinitionQuery processDefinitionKeyLike​(String 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%
      • 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) of processDefinitionKeyLike(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) or deploymentId(String)
      • processDefinitionResourceName

        ProcessDefinitionQuery processDefinitionResourceName​(String resourceName)
        Only select process definition with the given resource name.
      • processDefinitionResourceNameLike

        ProcessDefinitionQuery processDefinitionResourceNameLike​(String resourceNameLike)
        Only select process definition with a resource name like the given .
      • startableByUser

        ProcessDefinitionQuery startableByUser​(String userId)
        Only selects process definitions which given userId is authorized to start
      • incidentMessage

        ProcessDefinitionQuery incidentMessage​(String incidentMessage)
        Only selects process definitions with the given incident message.
      • incidentMessageLike

        ProcessDefinitionQuery incidentMessageLike​(String incidentMessageLike)
        Only selects process definitions with an incident message like the given.
      • versionTagLike

        ProcessDefinitionQuery versionTagLike​(String versionTagLike)
        Only selects process definitions with a version tag like the given
      • withoutVersionTag

        ProcessDefinitionQuery withoutVersionTag()
        Only selects process definitions without a version tag
      • messageEventSubscriptionName

        ProcessDefinitionQuery messageEventSubscriptionName​(String messageName)
        Selects the single process definition which has a start message event with the messageName.
      • 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 with tenantIdIn(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.
      • orderByVersionTag

        ProcessDefinitionQuery orderByVersionTag()
        Order by version tag (needs to be followed by Query.asc() or Query.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.