public class ProcessDefinitionQueryImpl extends AbstractQuery<ProcessDefinitionQuery,ProcessDefinition> implements ProcessDefinitionQuery
AbstractQuery.ResultType
commandExecutor, expressions, maxResultsLimitEnabled, resultType, SORTORDER_ASC, SORTORDER_DESC, validators
authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck
Constructor and Description |
---|
ProcessDefinitionQueryImpl() |
ProcessDefinitionQueryImpl(CommandExecutor commandExecutor) |
Modifier and Type | Method and Description |
---|---|
ProcessDefinitionQuery |
active()
Only selects process definitions which are active
|
void |
addProcessDefinitionCreatePermissionCheck(CompositePermissionCheck processDefinitionCreatePermissionCheck) |
protected void |
addProcessDefinitionToCacheAndRetrieveDocumentation(List<ProcessDefinition> list) |
void |
checkQueryOk() |
ProcessDefinitionQueryImpl |
deployedAfter(Date deployedAfter)
Only select process definitions that were deployed after the given Date (exclusive).
|
ProcessDefinitionQueryImpl |
deployedAt(Date deployedAt)
Only select process definitions that were deployed at the given Date.
|
ProcessDefinitionQueryImpl |
deploymentId(String deploymentId)
Only select process definitions that are deployed in a deployment with the
given deployment id
|
ProcessDefinitionQuery |
eventSubscription(EventType 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> |
getCandidateGroups() |
String |
getCategory() |
String |
getCategoryLike() |
Date |
getDeployedAfter() |
Date |
getDeployedAt() |
String |
getDeploymentId() |
String |
getId() |
String[] |
getIds() |
String |
getIncidentId() |
String |
getIncidentMessage() |
String |
getIncidentMessageLike() |
String |
getIncidentType() |
String |
getKey() |
String |
getKeyLike() |
String |
getName() |
String |
getNameLike() |
List<PermissionCheck> |
getProcessDefinitionCreatePermissionChecks() |
String |
getResourceName() |
String |
getResourceNameLike() |
SuspensionState |
getSuspensionState() |
Integer |
getVersion() |
String |
getVersionTag() |
protected boolean |
hasExcludingConditions()
Whether or not the query has excluding conditions.
|
ProcessDefinitionQuery |
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.
|
boolean |
isLatest() |
boolean |
isNotStartableInTasklist() |
boolean |
isShouldJoinDeploymentTable() |
boolean |
isStartableInTasklist() |
boolean |
isStartablePermissionCheck() |
ProcessDefinitionQueryImpl |
latestVersion()
Only select the process definitions which are the latest deployed (ie.
|
ProcessDefinitionQuery |
messageEventSubscription(String messageName) |
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 by
Query.asc() or Query.desc() ). |
ProcessDefinitionQuery |
orderByDeploymentTime()
Order by deployment time (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() ). |
ProcessDefinitionQuery |
orderByVersionTag()
Order by version tag (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 |
processDefinitionId(String processDefinitionId)
Only select process definiton with the given id.
|
ProcessDefinitionQueryImpl |
processDefinitionIdIn(String... ids)
Only select process definiton with the given id.
|
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 |
processDefinitionKeysIn(String... keys)
Only select process definitions 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) |
ProcessDefinitionQueryImpl |
processDefinitionVersion(Integer version)
Only select process definition with a certain version.
|
void |
setProcessDefinitionCreatePermissionChecks(List<PermissionCheck> processDefinitionCreatePermissionChecks) |
void |
setSuspensionState(SuspensionState suspensionState) |
ProcessDefinitionQueryImpl |
startableByUser(String userId)
Only selects process definitions which given userId is authorized to start
|
ProcessDefinitionQuery |
startableInTasklist()
Select process definitions which could be started in Tasklist.
|
ProcessDefinitionQuery |
startablePermissionCheck() |
ProcessDefinitionQuery |
suspended()
Only selects process definitions which are suspended
|
ProcessDefinitionQueryImpl |
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 tag
|
ProcessDefinitionQuery |
versionTagLike(String versionTagLike)
Only selects process definitions with a version tag like the given
|
ProcessDefinitionQuery |
withoutTenantId()
Only select process definitions which have no tenant id.
|
ProcessDefinitionQuery |
withoutVersionTag()
Only selects process definitions without a version tag
|
addExpression, addValidator, asc, checkMaxResultsLimit, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteDeploymentIdMappingsList, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeDeploymentIdMappingsList, executeIdsList, executeResult, executeSingleResult, extend, getExpressions, getMethod, list, listDeploymentIdMappings, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unlimitedList, validate, validate
getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
asc, count, desc, list, listPage, singleResult, unlimitedList
protected String id
protected String[] ids
protected String category
protected String categoryLike
protected String name
protected String nameLike
protected String deploymentId
protected Date deployedAfter
protected Date deployedAt
protected String key
protected String[] keys
protected String keyLike
protected String resourceName
protected String resourceNameLike
protected Integer version
protected boolean latest
protected SuspensionState suspensionState
protected String authorizationUserId
protected String procDefId
protected String incidentType
protected String incidentId
protected String incidentMessage
protected String incidentMessageLike
protected String eventSubscriptionName
protected String eventSubscriptionType
protected boolean isTenantIdSet
protected String[] tenantIds
protected boolean includeDefinitionsWithoutTenantId
protected boolean isVersionTagSet
protected String versionTag
protected String versionTagLike
protected boolean isStartableInTasklist
protected boolean isNotStartableInTasklist
protected boolean startablePermissionCheck
protected List<PermissionCheck> processDefinitionCreatePermissionChecks
public ProcessDefinitionQueryImpl()
public ProcessDefinitionQueryImpl(CommandExecutor commandExecutor)
public ProcessDefinitionQueryImpl processDefinitionId(String processDefinitionId)
ProcessDefinitionQuery
processDefinitionId
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl processDefinitionIdIn(String... ids)
ProcessDefinitionQuery
processDefinitionIdIn
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl processDefinitionCategory(String category)
ProcessDefinitionQuery
processDefinitionCategory
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl processDefinitionCategoryLike(String categoryLike)
ProcessDefinitionQuery
processDefinitionCategoryLike
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl processDefinitionName(String name)
ProcessDefinitionQuery
processDefinitionName
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl processDefinitionNameLike(String nameLike)
ProcessDefinitionQuery
processDefinitionNameLike
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl deploymentId(String deploymentId)
ProcessDefinitionQuery
deploymentId
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl deployedAfter(Date deployedAfter)
ProcessDefinitionQuery
deployedAfter
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl deployedAt(Date deployedAt)
ProcessDefinitionQuery
deployedAt
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl processDefinitionKey(String key)
ProcessDefinitionQuery
processDefinitionKey
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl processDefinitionKeysIn(String... keys)
ProcessDefinitionQuery
processDefinitionKeysIn
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl processDefinitionKeyLike(String keyLike)
ProcessDefinitionQuery
processDefinitionKeyLike
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl processDefinitionResourceName(String resourceName)
ProcessDefinitionQuery
processDefinitionResourceName
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl processDefinitionResourceNameLike(String resourceNameLike)
ProcessDefinitionQuery
processDefinitionResourceNameLike
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl processDefinitionVersion(Integer version)
ProcessDefinitionQuery
ProcessDefinitionQuery.processDefinitionKey(String)
processDefinitionVersion
in interface ProcessDefinitionQuery
public ProcessDefinitionQueryImpl latestVersion()
ProcessDefinitionQuery
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 ProcessDefinitionQuery.processDefinitionKey(String)
of ProcessDefinitionQuery.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.
latestVersion
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery active()
ProcessDefinitionQuery
active
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery suspended()
ProcessDefinitionQuery
suspended
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery messageEventSubscription(String messageName)
messageEventSubscription
in interface ProcessDefinitionQuery
ProcessDefinitionQuery.messageEventSubscriptionName(String)
public ProcessDefinitionQuery messageEventSubscriptionName(String messageName)
ProcessDefinitionQuery
messageEventSubscriptionName
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery processDefinitionStarter(String procDefId)
public ProcessDefinitionQuery eventSubscription(EventType eventType, String eventName)
public ProcessDefinitionQuery incidentType(String incidentType)
ProcessDefinitionQuery
incidentType
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery incidentId(String incidentId)
ProcessDefinitionQuery
incidentId
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery incidentMessage(String incidentMessage)
ProcessDefinitionQuery
incidentMessage
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery incidentMessageLike(String incidentMessageLike)
ProcessDefinitionQuery
incidentMessageLike
in interface ProcessDefinitionQuery
protected boolean hasExcludingConditions()
AbstractQuery
hasExcludingConditions
in class AbstractQuery<ProcessDefinitionQuery,ProcessDefinition>
true
if the query does have excluding conditions, false
otherwisepublic ProcessDefinitionQueryImpl tenantIdIn(String... tenantIds)
ProcessDefinitionQuery
tenantIdIn
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery withoutTenantId()
ProcessDefinitionQuery
withoutTenantId
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery includeProcessDefinitionsWithoutTenantId()
ProcessDefinitionQuery
ProcessDefinitionQuery.tenantIdIn(String...)
.includeProcessDefinitionsWithoutTenantId
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery versionTag(String versionTag)
ProcessDefinitionQuery
versionTag
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery versionTagLike(String versionTagLike)
ProcessDefinitionQuery
versionTagLike
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery withoutVersionTag()
ProcessDefinitionQuery
withoutVersionTag
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery startableInTasklist()
ProcessDefinitionQuery
startableInTasklist
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery notStartableInTasklist()
ProcessDefinitionQuery
notStartableInTasklist
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery startablePermissionCheck()
startablePermissionCheck
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery orderByDeploymentId()
ProcessDefinitionQuery
Query.asc()
or Query.desc()
).orderByDeploymentId
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery orderByDeploymentTime()
ProcessDefinitionQuery
Query.asc()
or Query.desc()
).orderByDeploymentTime
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery orderByProcessDefinitionKey()
ProcessDefinitionQuery
Query.asc()
or Query.desc()
).orderByProcessDefinitionKey
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery orderByProcessDefinitionCategory()
ProcessDefinitionQuery
Query.asc()
or Query.desc()
).orderByProcessDefinitionCategory
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery orderByProcessDefinitionId()
ProcessDefinitionQuery
Query.asc()
or Query.desc()
).orderByProcessDefinitionId
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery orderByProcessDefinitionVersion()
ProcessDefinitionQuery
Query.asc()
or Query.desc()
).orderByProcessDefinitionVersion
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery orderByProcessDefinitionName()
ProcessDefinitionQuery
Query.asc()
or Query.desc()
).orderByProcessDefinitionName
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery orderByTenantId()
ProcessDefinitionQuery
Query.asc()
or Query.desc()
).
Note that the ordering of process instances without tenant id is database-specific.orderByTenantId
in interface ProcessDefinitionQuery
public ProcessDefinitionQuery orderByVersionTag()
ProcessDefinitionQuery
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.orderByVersionTag
in interface ProcessDefinitionQuery
public long executeCount(CommandContext commandContext)
executeCount
in class AbstractQuery<ProcessDefinitionQuery,ProcessDefinition>
public List<ProcessDefinition> executeList(CommandContext commandContext, Page page)
AbstractQuery
executeList
in class AbstractQuery<ProcessDefinitionQuery,ProcessDefinition>
page
- used if the results must be paged. If null, no paging will be applied.protected void addProcessDefinitionToCacheAndRetrieveDocumentation(List<ProcessDefinition> list)
public void checkQueryOk()
checkQueryOk
in class AbstractQuery<ProcessDefinitionQuery,ProcessDefinition>
public String getDeploymentId()
public Date getDeployedAfter()
public Date getDeployedAt()
public String getId()
public String[] getIds()
public String getName()
public String getNameLike()
public String getKey()
public String getKeyLike()
public Integer getVersion()
public boolean isLatest()
public String getCategory()
public String getCategoryLike()
public String getResourceName()
public String getResourceNameLike()
public SuspensionState getSuspensionState()
public void setSuspensionState(SuspensionState suspensionState)
public String getIncidentId()
public String getIncidentType()
public String getIncidentMessage()
public String getIncidentMessageLike()
public String getVersionTag()
public boolean isStartableInTasklist()
public boolean isNotStartableInTasklist()
public boolean isStartablePermissionCheck()
public void setProcessDefinitionCreatePermissionChecks(List<PermissionCheck> processDefinitionCreatePermissionChecks)
public List<PermissionCheck> getProcessDefinitionCreatePermissionChecks()
public boolean isShouldJoinDeploymentTable()
public void addProcessDefinitionCreatePermissionCheck(CompositePermissionCheck processDefinitionCreatePermissionCheck)
public ProcessDefinitionQueryImpl startableByUser(String userId)
ProcessDefinitionQuery
startableByUser
in interface ProcessDefinitionQuery
Copyright © 2021. All rights reserved.