Interface ProcessDefinitionQuery

All Superinterfaces:
Query<ProcessDefinitionQuery,ProcessDefinition>
All Known Implementing Classes:
ProcessDefinitionQueryImpl

public interface ProcessDefinitionQuery extends Query<ProcessDefinitionQuery,ProcessDefinition>
Allows programmatic querying of ProcessDefinitions.
Author:
Tom Baeyens, Joram Barrez, Daniel Meyer, Saeid Mirzaei
  • Method Details Link icon

    • processDefinitionId Link icon

      ProcessDefinitionQuery processDefinitionId(String processDefinitionId)
      Only select process definition with the given id.
    • processDefinitionIdIn Link icon

      ProcessDefinitionQuery processDefinitionIdIn(String... ids)
      Only select process definition with the given id.
    • processDefinitionCategory Link icon

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

      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 Link icon

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

      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 Link icon

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

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

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

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

      @Deprecated ProcessDefinitionQueryImpl processDefinitionKeysIn(String... processDefinitionKeys)
      Deprecated.
      Only select process definitions with the given keys.

      Deprecated: use processDefinitionKeyIn(String...)

    • processDefinitionKeyIn Link icon

      ProcessDefinitionQuery processDefinitionKeyIn(String... processDefinitionKeys)
      Only select process definitions with the given keys.
      Parameters:
      processDefinitionKeys - keys to look for during query.
      Returns:
      query builder.
    • processDefinitionKeyLike Link icon

      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%
    • processDefinitionVersion Link icon

      ProcessDefinitionQuery processDefinitionVersion(Integer processDefinitionVersion)
      Only select process definition with a certain version. Particularly useful when used in combination with processDefinitionKey(String)
    • latestVersion Link icon

      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
      invalid reference
      #groupId(string)
      ,
      invalid reference
      #processDefinitionVersion(int)
      or deploymentId(String)
    • processDefinitionResourceName Link icon

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

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

      ProcessDefinitionQuery startableByUser(String userId)
      Only selects process definitions which given userId is authorized to start
    • suspended Link icon

      Only selects process definitions which are suspended
    • active Link icon

      Only selects process definitions which are active
    • incidentType Link icon

      ProcessDefinitionQuery incidentType(String incidentType)
      Only selects process definitions with the given incident type.
    • incidentId Link icon

      ProcessDefinitionQuery incidentId(String incidentId)
      Only selects process definitions with the given incident id.
    • incidentMessage Link icon

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

      ProcessDefinitionQuery incidentMessageLike(String incidentMessageLike)
      Only selects process definitions with an incident message like the given.
    • versionTag Link icon

      ProcessDefinitionQuery versionTag(String versionTag)
      Only selects process definitions with a specific version tag
    • versionTagLike Link icon

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

      ProcessDefinitionQuery withoutVersionTag()
      Only selects process definitions without a version tag
    • messageEventSubscription Link icon

      @Deprecated ProcessDefinitionQuery messageEventSubscription(String messageName)
      Deprecated.
      See Also:
    • messageEventSubscriptionName Link icon

      ProcessDefinitionQuery messageEventSubscriptionName(String messageName)
      Selects the single process definition which has a start message event with the messageName.
    • tenantIdIn Link icon

      ProcessDefinitionQuery tenantIdIn(String... tenantIds)
      Only select process definitions with one of the given tenant ids.
    • withoutTenantId Link icon

      ProcessDefinitionQuery withoutTenantId()
      Only select process definitions which have no tenant id.
    • includeProcessDefinitionsWithoutTenantId Link icon

      ProcessDefinitionQuery includeProcessDefinitionsWithoutTenantId()
      Select process definitions which have no tenant id. Can be used in combination with tenantIdIn(String...).
    • startableInTasklist Link icon

      ProcessDefinitionQuery startableInTasklist()
      Select process definitions which could be started in Tasklist.
    • notStartableInTasklist Link icon

      ProcessDefinitionQuery notStartableInTasklist()
      Select process definitions which could not be started in Tasklist.
    • startablePermissionCheck Link icon

      ProcessDefinitionQuery startablePermissionCheck()
    • orderByProcessDefinitionCategory Link icon

      ProcessDefinitionQuery orderByProcessDefinitionCategory()
      Order by the category of the process definitions (needs to be followed by Query.asc() or Query.desc()).
    • orderByProcessDefinitionKey Link icon

      ProcessDefinitionQuery orderByProcessDefinitionKey()
      Order by process definition key (needs to be followed by Query.asc() or Query.desc()).
    • orderByProcessDefinitionId Link icon

      ProcessDefinitionQuery orderByProcessDefinitionId()
      Order by the id of the process definitions (needs to be followed by Query.asc() or Query.desc()).
    • orderByProcessDefinitionVersion Link icon

      ProcessDefinitionQuery orderByProcessDefinitionVersion()
      Order by the version of the process definitions (needs to be followed by Query.asc() or Query.desc()).
    • orderByProcessDefinitionName Link icon

      ProcessDefinitionQuery orderByProcessDefinitionName()
      Order by the name of the process definitions (needs to be followed by Query.asc() or Query.desc()).
    • orderByDeploymentId Link icon

      ProcessDefinitionQuery orderByDeploymentId()
      Order by deployment id (needs to be followed by Query.asc() or Query.desc()).
    • orderByDeploymentTime Link icon

      ProcessDefinitionQuery orderByDeploymentTime()
      Order by deployment time (needs to be followed by Query.asc() or Query.desc()).
    • orderByTenantId Link icon

      ProcessDefinitionQuery orderByTenantId()
      Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of process instances without tenant id is database-specific.
    • orderByVersionTag Link icon

      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.