Interface CaseDefinitionQuery
-
- All Superinterfaces:
Query<CaseDefinitionQuery,CaseDefinition>
- All Known Implementing Classes:
CaseDefinitionQueryImpl
public interface CaseDefinitionQuery extends Query<CaseDefinitionQuery,CaseDefinition>
- Author:
- Roman Smirnov
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.CaseDefinitionQuery
deploymentId(String deploymentId)
Only select case definitions that are deployed in a deployment with the given deployment id.CaseDefinitionQuery
includeCaseDefinitionsWithoutTenantId()
Select case definitions which have no tenant id.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 byQuery.asc()
orQuery.desc()
).CaseDefinitionQuery
orderByCaseDefinitionId()
Order by the id of the case definitions (needs to be followed byQuery.asc()
orQuery.desc()
).CaseDefinitionQuery
orderByCaseDefinitionKey()
Order by case definition key (needs to be followed byQuery.asc()
orQuery.desc()
).CaseDefinitionQuery
orderByCaseDefinitionName()
Order by the name of the case definitions (needs to be followed byQuery.asc()
orQuery.desc()
).CaseDefinitionQuery
orderByCaseDefinitionVersion()
Order by the version of the case definitions (needs to be followed byQuery.asc()
orQuery.desc()
).CaseDefinitionQuery
orderByDeploymentId()
Order by deployment id (needs to be followed byQuery.asc()
orQuery.desc()
).CaseDefinitionQuery
orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.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 interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
-
-
-
Method Detail
-
caseDefinitionId
CaseDefinitionQuery caseDefinitionId(String caseDefinitionId)
Only select case definition with the given id.- Parameters:
caseDefinitionId
- the id of the case definition
-
caseDefinitionIdIn
CaseDefinitionQuery caseDefinitionIdIn(String... ids)
Only select case definitions with the given ids.- Parameters:
ids
- list of case definition ids
-
caseDefinitionCategory
CaseDefinitionQuery caseDefinitionCategory(String caseDefinitionCategory)
Only select case definitions with the given category.- Parameters:
caseDefinitionCategory
- the category of the case definition
-
caseDefinitionCategoryLike
CaseDefinitionQuery caseDefinitionCategoryLike(String caseDefinitionCategoryLike)
Only select case definitions where the category matches the given parameter. The syntax that should be used is the same as in SQL, eg. %activiti%- Parameters:
caseDefinitionCategoryLike
- the pattern to match the case definition category
-
caseDefinitionName
CaseDefinitionQuery caseDefinitionName(String caseDefinitionName)
Only select case definitions with the given name.- Parameters:
caseDefinitionName
- the name of the case definition
-
caseDefinitionKey
CaseDefinitionQuery caseDefinitionKey(String caseDefinitionKey)
Only select case definition with the given key.- Parameters:
caseDefinitionKey
- the key of the case definition
-
caseDefinitionKeyLike
CaseDefinitionQuery caseDefinitionKeyLike(String caseDefinitionKeyLike)
Only select case definitions where the key matches the given parameter. The syntax that should be used is the same as in SQL, eg. %activiti%- Parameters:
caseDefinitionKeyLike
- the pattern to match the case definition key
-
caseDefinitionNameLike
CaseDefinitionQuery caseDefinitionNameLike(String caseDefinitionNameLike)
Only select case definitions where the name matches the given parameter. The syntax that should be used is the same as in SQL, eg. %activiti%- Parameters:
caseDefinitionNameLike
- the pattern to match the case definition name
-
deploymentId
CaseDefinitionQuery deploymentId(String deploymentId)
Only select case definitions that are deployed in a deployment with the given deployment id.- Parameters:
deploymentId
- the id of the deployment
-
caseDefinitionVersion
CaseDefinitionQuery caseDefinitionVersion(Integer caseDefinitionVersion)
Only select case definition with a certain version. Particularly useful when used in combination withcaseDefinitionKey(String)
- Parameters:
caseDefinitionVersion
- the version of the case definition
-
latestVersion
CaseDefinitionQuery latestVersion()
Only select the case definitions which are the latest deployed (ie. which have the highest version number for the given key). Can only be used in combination withcaseDefinitionKey(String)
orcaseDefinitionKeyLike(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.
-
caseDefinitionResourceName
CaseDefinitionQuery caseDefinitionResourceName(String resourceName)
Only select case definition with the given resource name.- Parameters:
resourceName
- the name of the resource
-
caseDefinitionResourceNameLike
CaseDefinitionQuery caseDefinitionResourceNameLike(String resourceNameLike)
Only select case definition with a resource name like the given. The syntax that should be used is the same as in SQL, eg. %activiti%- Parameters:
resourceNameLike
- the pattern to match the resource name
-
tenantIdIn
CaseDefinitionQuery tenantIdIn(String... tenantIds)
Only select case definitions with one of the given tenant ids.
-
withoutTenantId
CaseDefinitionQuery withoutTenantId()
Only select case definitions which have no tenant id.
-
includeCaseDefinitionsWithoutTenantId
CaseDefinitionQuery includeCaseDefinitionsWithoutTenantId()
Select case definitions which have no tenant id. Can be used in combination withtenantIdIn(String...)
.
-
orderByCaseDefinitionCategory
CaseDefinitionQuery orderByCaseDefinitionCategory()
Order by the category of the case definitions (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByCaseDefinitionKey
CaseDefinitionQuery orderByCaseDefinitionKey()
Order by case definition key (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByCaseDefinitionId
CaseDefinitionQuery orderByCaseDefinitionId()
Order by the id of the case definitions (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByCaseDefinitionVersion
CaseDefinitionQuery orderByCaseDefinitionVersion()
Order by the version of the case definitions (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByCaseDefinitionName
CaseDefinitionQuery orderByCaseDefinitionName()
Order by the name of the case definitions (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByDeploymentId
CaseDefinitionQuery orderByDeploymentId()
Order by deployment id (needs to be followed byQuery.asc()
orQuery.desc()
).
-
orderByTenantId
CaseDefinitionQuery orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). Note that the ordering of case instances without tenant id is database-specific.
-
-