|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.camunda.bpm.engine.impl.db.ListQueryParameterObject
org.camunda.bpm.engine.impl.AbstractQuery<CaseDefinitionQuery,CaseDefinition>
org.camunda.bpm.engine.impl.cmmn.entity.repository.CaseDefinitionQueryImpl
public class CaseDefinitionQueryImpl
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery |
|---|
AbstractQuery.ResultType |
| Field Summary | |
|---|---|
protected String |
category
|
protected String |
categoryLike
|
protected String |
deploymentId
|
protected String |
id
|
protected String[] |
ids
|
protected boolean |
includeDefinitionsWithoutTenantId
|
protected boolean |
isTenantIdSet
|
protected String |
key
|
protected String |
keyLike
|
protected boolean |
latest
|
protected String |
name
|
protected String |
nameLike
|
protected String |
resourceName
|
protected String |
resourceNameLike
|
protected String[] |
tenantIds
|
protected Integer |
version
|
| Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery |
|---|
commandExecutor, expressions, orderingProperties, resultType, SORTORDER_ASC, SORTORDER_DESC, validators |
| Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject |
|---|
authCheck, databaseType, DEFAULT_ORDER_BY, firstResult, maxResults, orderBy, parameter, tenantCheck |
| Constructor Summary | |
|---|---|
CaseDefinitionQueryImpl()
|
|
CaseDefinitionQueryImpl(CommandExecutor commandExecutor)
|
|
| Method Summary | |
|---|---|
CaseDefinitionQuery |
caseDefinitionCategory(String caseDefinitionCategory)
Only select case definitions with the given category. |
CaseDefinitionQuery |
caseDefinitionCategoryLike(String caseDefinitionCategoryLike)
Only select case definitions where the category matches the given parameter. |
CaseDefinitionQuery |
caseDefinitionId(String caseDefinitionId)
Only select case definition with the given id. |
CaseDefinitionQuery |
caseDefinitionIdIn(String... ids)
Only select case definitions with the given ids. |
CaseDefinitionQuery |
caseDefinitionKey(String caseDefinitionKey)
Only select case definition with the given key. |
CaseDefinitionQuery |
caseDefinitionKeyLike(String caseDefinitionKeyLike)
Only select case definitions where the key matches the given parameter. |
CaseDefinitionQuery |
caseDefinitionName(String caseDefinitionName)
Only select case definitions with the given name. |
CaseDefinitionQuery |
caseDefinitionNameLike(String caseDefinitionNameLike)
Only select case definitions where the name matches the given parameter. |
CaseDefinitionQuery |
caseDefinitionResourceName(String resourceName)
Only select case definition with the given resource name. |
CaseDefinitionQuery |
caseDefinitionResourceNameLike(String resourceNameLike)
Only select case definition with a resource name like the given. |
CaseDefinitionQuery |
caseDefinitionVersion(Integer caseDefinitionVersion)
Only select case definition with a certain version. |
void |
checkQueryOk()
|
CaseDefinitionQuery |
deploymentId(String deploymentId)
Only select case definitions that are deployed in a deployment with the given deployment id. |
long |
executeCount(CommandContext commandContext)
|
List<CaseDefinition> |
executeList(CommandContext commandContext,
Page page)
Executes the actual query to retrieve the list of results. |
String |
getCategory()
|
String |
getCategoryLike()
|
String |
getDeploymentId()
|
String |
getId()
|
String[] |
getIds()
|
String |
getKey()
|
String |
getKeyLike()
|
String |
getName()
|
String |
getNameLike()
|
String |
getResourceName()
|
String |
getResourceNameLike()
|
Integer |
getVersion()
|
protected boolean |
hasExcludingConditions()
Whether or not the query has excluding conditions. |
CaseDefinitionQuery |
includeCaseDefinitionsWithoutTenantId()
Select case definitions which have no tenant id. |
boolean |
isLatest()
|
CaseDefinitionQuery |
latestVersion()
Only select the case definitions which are the latest deployed (ie. |
CaseDefinitionQuery |
orderByCaseDefinitionCategory()
Order by the category of the case definitions (needs to be followed by Query.asc() or Query.desc()). |
CaseDefinitionQuery |
orderByCaseDefinitionId()
Order by the id of the case definitions (needs to be followed by Query.asc() or Query.desc()). |
CaseDefinitionQuery |
orderByCaseDefinitionKey()
Order by case definition key (needs to be followed by Query.asc() or
Query.desc()). |
CaseDefinitionQuery |
orderByCaseDefinitionName()
Order by the name of the case definitions (needs to be followed by Query.asc() or Query.desc()). |
CaseDefinitionQuery |
orderByCaseDefinitionVersion()
Order by the version of the case definitions (needs to be followed by Query.asc() or Query.desc()). |
CaseDefinitionQuery |
orderByDeploymentId()
Order by deployment id (needs to be followed by Query.asc()
or Query.desc()). |
CaseDefinitionQuery |
orderByTenantId()
Order by tenant id (needs to be followed by Query.asc() or Query.desc()). |
CaseDefinitionQuery |
tenantIdIn(String... tenantIds)
Only select case definitions with one of the given tenant ids. |
CaseDefinitionQuery |
withoutTenantId()
Only select case definitions which have no tenant id. |
| Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery |
|---|
addExpression, addValidator, asc, count, desc, direction, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteList, execute, executeSingleResult, extend, getExpressions, getMethod, getOrderBy, getOrderingProperties, list, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, setOrderingProperties, singleResult, validate, validate |
| Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject |
|---|
getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderBy, setParameter, setTenantCheck |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.camunda.bpm.engine.query.Query |
|---|
asc, count, desc, list, listPage, singleResult |
| Field Detail |
|---|
protected String id
protected String[] ids
protected String category
protected String categoryLike
protected String name
protected String nameLike
protected String deploymentId
protected String key
protected String keyLike
protected String resourceName
protected String resourceNameLike
protected Integer version
protected boolean latest
protected boolean isTenantIdSet
protected String[] tenantIds
protected boolean includeDefinitionsWithoutTenantId
| Constructor Detail |
|---|
public CaseDefinitionQueryImpl()
public CaseDefinitionQueryImpl(CommandExecutor commandExecutor)
| Method Detail |
|---|
public CaseDefinitionQuery caseDefinitionId(String caseDefinitionId)
CaseDefinitionQuery
caseDefinitionId in interface CaseDefinitionQuerycaseDefinitionId - the id of the case definitionpublic CaseDefinitionQuery caseDefinitionIdIn(String... ids)
CaseDefinitionQuery
caseDefinitionIdIn in interface CaseDefinitionQueryids - list of case definition idspublic CaseDefinitionQuery caseDefinitionCategory(String caseDefinitionCategory)
CaseDefinitionQuery
caseDefinitionCategory in interface CaseDefinitionQuerycaseDefinitionCategory - the category of the case definitionpublic CaseDefinitionQuery caseDefinitionCategoryLike(String caseDefinitionCategoryLike)
CaseDefinitionQuery
caseDefinitionCategoryLike in interface CaseDefinitionQuerycaseDefinitionCategoryLike - the pattern to match the case definition categorypublic CaseDefinitionQuery caseDefinitionName(String caseDefinitionName)
CaseDefinitionQuery
caseDefinitionName in interface CaseDefinitionQuerycaseDefinitionName - the name of the case definitionpublic CaseDefinitionQuery caseDefinitionNameLike(String caseDefinitionNameLike)
CaseDefinitionQuery
caseDefinitionNameLike in interface CaseDefinitionQuerycaseDefinitionNameLike - the pattern to match the case definition namepublic CaseDefinitionQuery caseDefinitionKey(String caseDefinitionKey)
CaseDefinitionQuery
caseDefinitionKey in interface CaseDefinitionQuerycaseDefinitionKey - the key of the case definitionpublic CaseDefinitionQuery caseDefinitionKeyLike(String caseDefinitionKeyLike)
CaseDefinitionQuery
caseDefinitionKeyLike in interface CaseDefinitionQuerycaseDefinitionKeyLike - the pattern to match the case definition keypublic CaseDefinitionQuery deploymentId(String deploymentId)
CaseDefinitionQuery
deploymentId in interface CaseDefinitionQuerydeploymentId - the id of the deploymentpublic CaseDefinitionQuery caseDefinitionVersion(Integer caseDefinitionVersion)
CaseDefinitionQueryCaseDefinitionQuery.caseDefinitionKey(String)
caseDefinitionVersion in interface CaseDefinitionQuerycaseDefinitionVersion - the version of the case definitionpublic CaseDefinitionQuery latestVersion()
CaseDefinitionQueryCaseDefinitionQuery.caseDefinitionKey(String)
or CaseDefinitionQuery.caseDefinitionKeyLike(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 case definitions.
latestVersion in interface CaseDefinitionQuerypublic CaseDefinitionQuery caseDefinitionResourceName(String resourceName)
CaseDefinitionQuery
caseDefinitionResourceName in interface CaseDefinitionQueryresourceName - the name of the resourcepublic CaseDefinitionQuery caseDefinitionResourceNameLike(String resourceNameLike)
CaseDefinitionQuery
caseDefinitionResourceNameLike in interface CaseDefinitionQueryresourceNameLike - the pattern to match the resource namepublic CaseDefinitionQuery tenantIdIn(String... tenantIds)
CaseDefinitionQuery
tenantIdIn in interface CaseDefinitionQuerypublic CaseDefinitionQuery withoutTenantId()
CaseDefinitionQuery
withoutTenantId in interface CaseDefinitionQuerypublic CaseDefinitionQuery includeCaseDefinitionsWithoutTenantId()
CaseDefinitionQueryCaseDefinitionQuery.tenantIdIn(String...).
includeCaseDefinitionsWithoutTenantId in interface CaseDefinitionQuerypublic CaseDefinitionQuery orderByCaseDefinitionCategory()
CaseDefinitionQueryQuery.asc() or Query.desc()).
orderByCaseDefinitionCategory in interface CaseDefinitionQuerypublic CaseDefinitionQuery orderByCaseDefinitionKey()
CaseDefinitionQueryQuery.asc() or
Query.desc()).
orderByCaseDefinitionKey in interface CaseDefinitionQuerypublic CaseDefinitionQuery orderByCaseDefinitionId()
CaseDefinitionQueryQuery.asc() or Query.desc()).
orderByCaseDefinitionId in interface CaseDefinitionQuerypublic CaseDefinitionQuery orderByCaseDefinitionVersion()
CaseDefinitionQueryQuery.asc() or Query.desc()).
orderByCaseDefinitionVersion in interface CaseDefinitionQuerypublic CaseDefinitionQuery orderByCaseDefinitionName()
CaseDefinitionQueryQuery.asc() or Query.desc()).
orderByCaseDefinitionName in interface CaseDefinitionQuerypublic CaseDefinitionQuery orderByDeploymentId()
CaseDefinitionQueryQuery.asc()
or Query.desc()).
orderByDeploymentId in interface CaseDefinitionQuerypublic CaseDefinitionQuery orderByTenantId()
CaseDefinitionQueryQuery.asc() or Query.desc()).
Note that the ordering of case instances without tenant id is database-specific.
orderByTenantId in interface CaseDefinitionQueryprotected boolean hasExcludingConditions()
AbstractQuery
hasExcludingConditions in class AbstractQuery<CaseDefinitionQuery,CaseDefinition>true if the query does have excluding conditions, false otherwisepublic long executeCount(CommandContext commandContext)
executeCount in class AbstractQuery<CaseDefinitionQuery,CaseDefinition>
public List<CaseDefinition> executeList(CommandContext commandContext,
Page page)
AbstractQuery
executeList in class AbstractQuery<CaseDefinitionQuery,CaseDefinition>page - used if the results must be paged. If null, no paging will be applied.public void checkQueryOk()
checkQueryOk in class AbstractQuery<CaseDefinitionQuery,CaseDefinition>public String getId()
public String[] getIds()
public String getCategory()
public String getCategoryLike()
public String getName()
public String getNameLike()
public String getDeploymentId()
public String getKey()
public String getKeyLike()
public String getResourceName()
public String getResourceNameLike()
public Integer getVersion()
public boolean isLatest()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||