Package org.activiti.engine.impl

Class ProcessDefinitionQueryImpl

java.lang.Object

org.activiti.engine.impl.db.ListQueryParameterObject

org.activiti.engine.impl.AbstractQuery<ProcessDefinitionQuery,ProcessDefinition>

org.activiti.engine.impl.ProcessDefinitionQueryImpl

All Implemented Interfaces:

Serializable, Command<Object>, Query<ProcessDefinitionQuery,ProcessDefinition>, ProcessDefinitionQuery

public class ProcessDefinitionQueryImpl
extends AbstractQuery<ProcessDefinitionQuery,ProcessDefinition>
implements ProcessDefinitionQuery

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.activiti.engine.impl.AbstractQuery

AbstractQuery.NullHandlingOnOrder

Field Summary

Fields inherited from class org.activiti.engine.impl.AbstractQuery

commandContext, commandExecutor, databaseType, nullHandlingOnOrder, orderBy, orderProperty, resultType, SORTORDER_ASC, SORTORDER_DESC

Fields inherited from class org.activiti.engine.impl.db.ListQueryParameterObject

firstResult, maxResults, parameter

Constructor Summary

Constructors

Constructor	Description
ProcessDefinitionQueryImpl()
ProcessDefinitionQueryImpl(CommandContext commandContext)
ProcessDefinitionQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
ProcessDefinitionQuery	active()	Only selects process definitions which are active
void	checkQueryOk()
protected void	checkVersion(Integer version)
ProcessDefinitionQueryImpl	deploymentId(String deploymentId)	Only select process definitions that are deployed in a deployment with the given deployment id
ProcessDefinitionQueryImpl	deploymentIds(Set<String> deploymentIds)	Select process definitions that are deployed in deployments with the given set of ids
ProcessDefinitionQuery	eventSubscription(String eventType, String eventName)
long	executeCount(CommandContext commandContext)
List<ProcessDefinition>	executeList(CommandContext commandContext, Page page)	Executes the actual query to retrieve the list of results.
List<String>	getAuthorizationGroups()
String	getAuthorizationUserId()
String	getCategory()
String	getCategoryLike()
String	getCategoryNotEquals()
String	getDeploymentId()
Set<String>	getDeploymentIds()
String	getEventSubscriptionName()
String	getEventSubscriptionType()
String	getId()
String	getIdOrKey()
Set<String>	getIds()
String	getKey()
String	getKeyLike()
Set<String>	getKeys()
String	getName()
String	getNameLike()
String	getProcDefId()
String	getResourceName()
String	getResourceNameLike()
SuspensionState	getSuspensionState()
String	getTenantId()
String	getTenantIdLike()
Integer	getVersion()
Integer	getVersionGt()
Integer	getVersionGte()
Integer	getVersionLt()
Integer	getVersionLte()
boolean	isLatest()
boolean	isWithoutTenantId()
ProcessDefinitionQueryImpl	latestVersion()	Only select the process definitions which are the latest deployed (ie. which have the highest version number for the given key).
ProcessDefinitionQuery	messageEventSubscription(String messageName)
ProcessDefinitionQuery	messageEventSubscriptionName(String messageName)	Selects the single process definition which has a start message event with the messageName.
ProcessDefinitionQuery	orderByDeploymentId()	Order by deployment id (needs to be followed by Query.asc() or Query.desc()).
ProcessDefinitionQuery	orderByProcessDefinitionAppVersion()	Order by the app version of the process definitions (needs to be followed by Query.asc() or Query.desc()).
ProcessDefinitionQuery	orderByProcessDefinitionCategory()	Order by the category of the process definitions (needs to be followed by Query.asc() or Query.desc()).
ProcessDefinitionQuery	orderByProcessDefinitionId()	Order by the id of the process definitions (needs to be followed by Query.asc() or Query.desc()).
ProcessDefinitionQuery	orderByProcessDefinitionKey()	Order by process definition key (needs to be followed by Query.asc() or Query.desc()).
ProcessDefinitionQuery	orderByProcessDefinitionName()	Order by the name of the process definitions (needs to be followed by Query.asc() or Query.desc()).
ProcessDefinitionQuery	orderByProcessDefinitionVersion()	Order by the version of the process definitions (needs to be followed by Query.asc() or Query.desc()).
ProcessDefinitionQuery	orderByTenantId()	Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
ProcessDefinitionQueryImpl	processDefinitionCategory(String category)	Only select process definitions with the given category.
ProcessDefinitionQueryImpl	processDefinitionCategoryLike(String categoryLike)	Only select process definitions where the category matches the given parameter.
ProcessDefinitionQueryImpl	processDefinitionCategoryNotEquals(String categoryNotEquals)	Only select deployments that have a different category then the given one.
ProcessDefinitionQueryImpl	processDefinitionId(String processDefinitionId)	Only select process definition with the given id.
ProcessDefinitionQuery	processDefinitionIdOrKey(String idOrKey)	Selects process definitions with id or key equals to processDefinitionIdOrKey
ProcessDefinitionQuery	processDefinitionIds(Set<String> processDefinitionIds)	Only select process definitions with the given ids.
ProcessDefinitionQueryImpl	processDefinitionKey(String key)	Only select process definition with the given key.
ProcessDefinitionQueryImpl	processDefinitionKeyLike(String keyLike)	Only select process definitions where the key matches the given parameter.
ProcessDefinitionQueryImpl	processDefinitionKeys(Set<String> keys)	Only select process definition with the given keys.
ProcessDefinitionQueryImpl	processDefinitionName(String name)	Only select process definitions with the given name.
ProcessDefinitionQueryImpl	processDefinitionNameLike(String nameLike)	Only select process definitions where the name matches the given parameter.
ProcessDefinitionQueryImpl	processDefinitionResourceName(String resourceName)	Only select process definition with the given resource name.
ProcessDefinitionQueryImpl	processDefinitionResourceNameLike(String resourceNameLike)	Only select process definition with a resource name like the given .
ProcessDefinitionQuery	processDefinitionStarter(String procDefId)
ProcessDefinitionQuery	processDefinitionTenantId(String tenantId)	Only select process definitions that have the given tenant id.
ProcessDefinitionQuery	processDefinitionTenantIdLike(String tenantIdLike)	Only select process definitions with a tenant id like the given one.
ProcessDefinitionQueryImpl	processDefinitionVersion(Integer version)	Only select process definition with a certain version.
ProcessDefinitionQuery	processDefinitionVersionGreaterThan(Integer processDefinitionVersion)	Only select process definitions which version are greater than a certain version.
ProcessDefinitionQuery	processDefinitionVersionGreaterThanOrEquals(Integer processDefinitionVersion)	Only select process definitions which version are greater than or equals a certain version.
ProcessDefinitionQuery	processDefinitionVersionLowerThan(Integer processDefinitionVersion)	Only select process definitions which version are lower than a certain version.
ProcessDefinitionQuery	processDefinitionVersionLowerThanOrEquals(Integer processDefinitionVersion)	Only select process definitions which version are lower than or equals a certain version.
ProcessDefinitionQuery	processDefinitionWithoutTenantId()	Only select process definitions that do not have a tenant id.
void	setSuspensionState(SuspensionState suspensionState)
ProcessDefinitionQuery	startableByGroups(List<String> groupIds)	Only selects process definitions which given group members are authorized to start If not set and startableByUser is set, the groups of that user will be used
ProcessDefinitionQueryImpl	startableByUser(String userId)	Only selects process definitions which given userId is authorized to start
ProcessDefinitionQuery	suspended()	Only selects process definitions which are suspended

Methods inherited from class org.activiti.engine.impl.AbstractQuery

addOrder, asc, count, desc, direction, execute, executeSingleResult, getDatabaseType, getOrderBy, getOrderByColumns, list, listPage, orderBy, orderBy, setCommandExecutor, setDatabaseType, singleResult

Methods inherited from class org.activiti.engine.impl.db.ListQueryParameterObject

getFirstResult, getFirstRow, getLastRow, getMaxResults, getParameter, setFirstResult, setMaxResults, setParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.activiti.engine.query.Query

asc, count, desc, list, listPage, orderBy, singleResult

Constructor Details

ProcessDefinitionQueryImpl

public ProcessDefinitionQueryImpl()

ProcessDefinitionQueryImpl

public ProcessDefinitionQueryImpl(CommandContext commandContext)

ProcessDefinitionQueryImpl

public ProcessDefinitionQueryImpl(CommandExecutor commandExecutor)

Method Details

processDefinitionId

public ProcessDefinitionQueryImpl processDefinitionId(String processDefinitionId)

Description copied from interface: ProcessDefinitionQuery

Only select process definition with the given id.

Specified by:

processDefinitionId in interface ProcessDefinitionQuery

processDefinitionIds

public ProcessDefinitionQuery processDefinitionIds(Set<String> processDefinitionIds)

Description copied from interface: ProcessDefinitionQuery

Only select process definitions with the given ids.

Specified by:

processDefinitionIds in interface ProcessDefinitionQuery

processDefinitionCategory

public ProcessDefinitionQueryImpl processDefinitionCategory(String category)

Description copied from interface: ProcessDefinitionQuery

Only select process definitions with the given category.

Specified by:

processDefinitionCategory in interface ProcessDefinitionQuery

processDefinitionCategoryLike

public ProcessDefinitionQueryImpl processDefinitionCategoryLike(String categoryLike)

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. %activiti%

Specified by:

processDefinitionCategoryLike in interface ProcessDefinitionQuery

processDefinitionCategoryNotEquals

public ProcessDefinitionQueryImpl processDefinitionCategoryNotEquals(String categoryNotEquals)

Description copied from interface: ProcessDefinitionQuery

Only select deployments that have a different category then the given one.

Specified by:

processDefinitionCategoryNotEquals in interface ProcessDefinitionQuery

See Also:

• DeploymentBuilder.category(String)

processDefinitionName

public ProcessDefinitionQueryImpl processDefinitionName(String name)

Description copied from interface: ProcessDefinitionQuery

Only select process definitions with the given name.

Specified by:

processDefinitionName in interface ProcessDefinitionQuery

processDefinitionNameLike

public ProcessDefinitionQueryImpl processDefinitionNameLike(String nameLike)

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. %activiti%

Specified by:

processDefinitionNameLike in interface ProcessDefinitionQuery

deploymentId

public ProcessDefinitionQueryImpl deploymentId(String 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 interface ProcessDefinitionQuery

deploymentIds

public ProcessDefinitionQueryImpl deploymentIds(Set<String> deploymentIds)

Description copied from interface: ProcessDefinitionQuery

Select process definitions that are deployed in deployments with the given set of ids

Specified by:

deploymentIds in interface ProcessDefinitionQuery

processDefinitionKey

public ProcessDefinitionQueryImpl processDefinitionKey(String key)

Description copied from interface: ProcessDefinitionQuery

Only select process definition with the given key.

Specified by:

processDefinitionKey in interface ProcessDefinitionQuery

processDefinitionIdOrKey

public ProcessDefinitionQuery processDefinitionIdOrKey(String idOrKey)

Description copied from interface: ProcessDefinitionQuery

Selects process definitions with id or key equals to processDefinitionIdOrKey

Specified by:

processDefinitionIdOrKey in interface ProcessDefinitionQuery

processDefinitionKeys

public ProcessDefinitionQueryImpl processDefinitionKeys(Set<String> keys)

Description copied from interface: ProcessDefinitionQuery

Only select process definition with the given keys.

Specified by:

processDefinitionKeys in interface ProcessDefinitionQuery

processDefinitionKeyLike

public ProcessDefinitionQueryImpl processDefinitionKeyLike(String keyLike)

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. %activiti%

Specified by:

processDefinitionKeyLike in interface ProcessDefinitionQuery

processDefinitionResourceName

public ProcessDefinitionQueryImpl processDefinitionResourceName(String resourceName)

Description copied from interface: ProcessDefinitionQuery

Only select process definition with the given resource name.

Specified by:

processDefinitionResourceName in interface ProcessDefinitionQuery

processDefinitionResourceNameLike

public ProcessDefinitionQueryImpl processDefinitionResourceNameLike(String resourceNameLike)

Description copied from interface: ProcessDefinitionQuery

Only select process definition with a resource name like the given .

Specified by:

processDefinitionResourceNameLike in interface ProcessDefinitionQuery

processDefinitionVersion

public ProcessDefinitionQueryImpl processDefinitionVersion(Integer version)

Description copied from interface: ProcessDefinitionQuery

Only select process definition with a certain version. Particulary useful when used in combination with ProcessDefinitionQuery.processDefinitionKey(String)

Specified by:

processDefinitionVersion in interface ProcessDefinitionQuery

processDefinitionVersionGreaterThan

public ProcessDefinitionQuery processDefinitionVersionGreaterThan(Integer processDefinitionVersion)

Description copied from interface: ProcessDefinitionQuery

Only select process definitions which version are greater than a certain version.

Specified by:

processDefinitionVersionGreaterThan in interface ProcessDefinitionQuery

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 interface ProcessDefinitionQuery

processDefinitionVersionLowerThan

public ProcessDefinitionQuery processDefinitionVersionLowerThan(Integer processDefinitionVersion)

Description copied from interface: ProcessDefinitionQuery

Only select process definitions which version are lower than a certain version.

Specified by:

processDefinitionVersionLowerThan in interface ProcessDefinitionQuery

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 interface ProcessDefinitionQuery

checkVersion

protected void checkVersion(Integer version)

latestVersion

public ProcessDefinitionQueryImpl 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 interface ProcessDefinitionQuery

active

public ProcessDefinitionQuery active()

Description copied from interface: ProcessDefinitionQuery

Only selects process definitions which are active

Specified by:

active in interface ProcessDefinitionQuery

suspended

public ProcessDefinitionQuery suspended()

Description copied from interface: ProcessDefinitionQuery

Only selects process definitions which are suspended

Specified by:

suspended in interface ProcessDefinitionQuery

processDefinitionTenantId

public ProcessDefinitionQuery processDefinitionTenantId(String tenantId)

Description copied from interface: ProcessDefinitionQuery

Only select process definitions that have the given tenant id.

Specified by:

processDefinitionTenantId in interface ProcessDefinitionQuery

processDefinitionTenantIdLike

public ProcessDefinitionQuery processDefinitionTenantIdLike(String tenantIdLike)

Description copied from interface: ProcessDefinitionQuery

Only select process definitions with a tenant id like the given one.

Specified by:

processDefinitionTenantIdLike in interface ProcessDefinitionQuery

processDefinitionWithoutTenantId

public ProcessDefinitionQuery processDefinitionWithoutTenantId()

Description copied from interface: ProcessDefinitionQuery

Only select process definitions that do not have a tenant id.

Specified by:

processDefinitionWithoutTenantId in interface ProcessDefinitionQuery

messageEventSubscription

public ProcessDefinitionQuery messageEventSubscription(String messageName)

messageEventSubscriptionName

public ProcessDefinitionQuery messageEventSubscriptionName(String messageName)

Description copied from interface: ProcessDefinitionQuery

Selects the single process definition which has a start message event with the messageName.

Specified by:

messageEventSubscriptionName in interface ProcessDefinitionQuery

processDefinitionStarter

public ProcessDefinitionQuery processDefinitionStarter(String procDefId)

eventSubscription

public ProcessDefinitionQuery eventSubscription(String eventType,
 String eventName)

getAuthorizationGroups

public List<String> getAuthorizationGroups()

orderByDeploymentId

public ProcessDefinitionQuery orderByDeploymentId()

Description copied from interface: ProcessDefinitionQuery

Order by deployment id (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByDeploymentId in interface ProcessDefinitionQuery

orderByProcessDefinitionKey

public ProcessDefinitionQuery orderByProcessDefinitionKey()

Description copied from interface: ProcessDefinitionQuery

Order by process definition key (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByProcessDefinitionKey in interface ProcessDefinitionQuery

orderByProcessDefinitionCategory

public ProcessDefinitionQuery orderByProcessDefinitionCategory()

Description copied from interface: ProcessDefinitionQuery

Order by the category of the process definitions (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByProcessDefinitionCategory in interface ProcessDefinitionQuery

orderByProcessDefinitionId

public ProcessDefinitionQuery orderByProcessDefinitionId()

Description copied from interface: ProcessDefinitionQuery

Order by the id of the process definitions (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByProcessDefinitionId in interface ProcessDefinitionQuery

orderByProcessDefinitionVersion

public ProcessDefinitionQuery orderByProcessDefinitionVersion()

Description copied from interface: ProcessDefinitionQuery

Order by the version of the process definitions (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByProcessDefinitionVersion in interface ProcessDefinitionQuery

orderByProcessDefinitionAppVersion

public ProcessDefinitionQuery orderByProcessDefinitionAppVersion()

Description copied from interface: ProcessDefinitionQuery

Order by the app version of the process definitions (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByProcessDefinitionAppVersion in interface ProcessDefinitionQuery

orderByProcessDefinitionName

public ProcessDefinitionQuery orderByProcessDefinitionName()

Description copied from interface: ProcessDefinitionQuery

Order by the name of the process definitions (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByProcessDefinitionName in interface ProcessDefinitionQuery

orderByTenantId

public ProcessDefinitionQuery orderByTenantId()

Description copied from interface: ProcessDefinitionQuery

Order by tenant id (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByTenantId in interface ProcessDefinitionQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<ProcessDefinitionQuery,ProcessDefinition>

executeList

public List<ProcessDefinition> executeList(CommandContext commandContext,
 Page page)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<ProcessDefinitionQuery,ProcessDefinition>

Parameters:

page - used if the results must be paged. If null, no paging will be applied.

checkQueryOk

public void checkQueryOk()

Overrides:

checkQueryOk in class AbstractQuery<ProcessDefinitionQuery,ProcessDefinition>

getDeploymentId

public String getDeploymentId()

getDeploymentIds

public Set<String> getDeploymentIds()

getId

public String getId()

getIds

public Set<String> getIds()

getName

public String getName()

getNameLike

public String getNameLike()

getKey

public String getKey()

getIdOrKey

public String getIdOrKey()

getKeyLike

public String getKeyLike()

getKeys

public Set<String> getKeys()

getVersion

public Integer getVersion()

getVersionGt

public Integer getVersionGt()

getVersionGte

public Integer getVersionGte()

getVersionLt

public Integer getVersionLt()

getVersionLte

public Integer getVersionLte()

isLatest

public boolean isLatest()

getCategory

public String getCategory()

getCategoryLike

public String getCategoryLike()

getResourceName

public String getResourceName()

getResourceNameLike

public String getResourceNameLike()

getSuspensionState

public SuspensionState getSuspensionState()

setSuspensionState

public void setSuspensionState(SuspensionState suspensionState)

getCategoryNotEquals

public String getCategoryNotEquals()

getTenantId

public String getTenantId()

getTenantIdLike

public String getTenantIdLike()

isWithoutTenantId

public boolean isWithoutTenantId()

getAuthorizationUserId

public String getAuthorizationUserId()

getProcDefId

public String getProcDefId()

getEventSubscriptionName

public String getEventSubscriptionName()

getEventSubscriptionType

public String getEventSubscriptionType()

startableByUser

public ProcessDefinitionQueryImpl startableByUser(String userId)

Description copied from interface: ProcessDefinitionQuery

Only selects process definitions which given userId is authorized to start

Specified by:

startableByUser in interface ProcessDefinitionQuery

startableByGroups

public ProcessDefinitionQuery startableByGroups(List<String> groupIds)

Description copied from interface: ProcessDefinitionQuery

Only selects process definitions which given group members are authorized to start If not set and startableByUser is set, the groups of that user will be used

Specified by:

startableByGroups in interface ProcessDefinitionQuery