FormDefinitionQueryImpl (Flowable 6.7.0 API)

java.lang.Object
- org.flowable.common.engine.impl.db.ListQueryParameterObject
- - org.flowable.common.engine.impl.query.AbstractQuery<FormDefinitionQuery,FormDefinition>
  - - org.flowable.form.engine.impl.FormDefinitionQueryImpl

All Implemented Interfaces:

Serializable, Query<FormDefinitionQuery,FormDefinition>, Command<Object>, FormDefinitionQuery
```
public class FormDefinitionQueryImpl
extends AbstractQuery<FormDefinitionQuery,FormDefinition>
implements FormDefinitionQuery
```
Author:

Tijs Rademakers, Joram Barrez

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
  ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType
- Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
  Query.NullHandlingOnOrder

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`category`
`protected String`	`categoryLike`
`protected String`	`categoryNotEquals`
`protected String`	`deploymentId`
`protected Set<String>`	`deploymentIds`
`protected String`	`id`
`protected Set<String>`	`ids`
`protected String`	`key`
`protected String`	`keyLike`
`protected boolean`	`latest`
`protected String`	`name`
`protected String`	`nameLike`
`protected String`	`resourceName`
`protected String`	`resourceNameLike`
`protected String`	`tenantId`
`protected String`	`tenantIdLike`
`protected Integer`	`version`
`protected Integer`	`versionGt`
`protected Integer`	`versionGte`
`protected Integer`	`versionLt`
`protected Integer`	`versionLte`
`protected boolean`	`withoutTenantId`

Fields inherited from class org.flowable.common.engine.impl.query.AbstractQuery
commandContext, commandExecutor

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
databaseType, DEFAULT_ORDER_BY, defaultOrderBy, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors
Constructor and Description

FormDefinitionQueryImpl()

FormDefinitionQueryImpl(CommandContext commandContext)

FormDefinitionQueryImpl(CommandExecutor commandExecutor)

Constructors
Constructor and Description
`FormDefinitionQueryImpl()`
`FormDefinitionQueryImpl(CommandContext commandContext)`
`FormDefinitionQueryImpl(CommandExecutor commandExecutor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkVersion(Integer version)`
`FormDefinitionQueryImpl`	`deploymentId(String deploymentId)` Only select forms that are deployed in a deployment with the given deployment id
`FormDefinitionQueryImpl`	`deploymentIds(Set<String> deploymentIds)` Select forms that are deployed in deployments with the given set of ids
`long`	`executeCount(CommandContext commandContext)`
`List<FormDefinition>`	`executeList(CommandContext commandContext)` Executes the actual query to retrieve the list of results.
`FormDefinitionQueryImpl`	`formCategory(String category)` Only select forms with the given category.
`FormDefinitionQueryImpl`	`formCategoryLike(String categoryLike)` Only select forms where the category matches the given parameter.
`FormDefinitionQueryImpl`	`formCategoryNotEquals(String categoryNotEquals)` Only select deployments that have a different category then the given one.
`FormDefinitionQueryImpl`	`formDefinitionKey(String key)` Only select form with the given key.
`FormDefinitionQueryImpl`	`formDefinitionKeyLike(String keyLike)` Only select forms where the key matches the given parameter.
`FormDefinitionQueryImpl`	`formId(String formId)` Only select form with the given id.
`FormDefinitionQuery`	`formIds(Set<String> formIds)` Only select forms with the given ids.
`FormDefinitionQueryImpl`	`formName(String name)` Only select forms with the given name.
`FormDefinitionQueryImpl`	`formNameLike(String nameLike)` Only select forms where the name matches the given parameter.
`FormDefinitionQueryImpl`	`formResourceName(String resourceName)` Only select form with the given resource name.
`FormDefinitionQueryImpl`	`formResourceNameLike(String resourceNameLike)` Only select form with a resource name like the given .
`FormDefinitionQuery`	`formTenantId(String tenantId)` Only select forms that have the given tenant id.
`FormDefinitionQuery`	`formTenantIdLike(String tenantIdLike)` Only select forms with a tenant id like the given one.
`FormDefinitionQueryImpl`	`formVersion(Integer version)` Only select form with a certain version.
`FormDefinitionQuery`	`formVersionGreaterThan(Integer formVersion)` Only select forms which version are greater than a certain version.
`FormDefinitionQuery`	`formVersionGreaterThanOrEquals(Integer formVersion)` Only select forms which version are greater than or equals a certain version.
`FormDefinitionQuery`	`formVersionLowerThan(Integer formVersion)` Only select forms which version are lower than a certain version.
`FormDefinitionQuery`	`formVersionLowerThanOrEquals(Integer formVersion)` Only select forms which version are lower than or equals a certain version.
`FormDefinitionQuery`	`formWithoutTenantId()` Only select forms that do not have a tenant id.
`String`	`getCategory()`
`String`	`getCategoryLike()`
`String`	`getCategoryNotEquals()`
`String`	`getDeploymentId()`
`Set<String>`	`getDeploymentIds()`
`String`	`getId()`
`Set<String>`	`getIds()`
`String`	`getKey()`
`String`	`getKeyLike()`
`String`	`getName()`
`String`	`getNameLike()`
`String`	`getResourceName()`
`String`	`getResourceNameLike()`
`String`	`getTenantId()`
`String`	`getTenantIdLike()`
`Integer`	`getVersion()`
`Integer`	`getVersionGt()`
`Integer`	`getVersionGte()`
`Integer`	`getVersionLt()`
`Integer`	`getVersionLte()`
`boolean`	`isLatest()`
`boolean`	`isWithoutTenantId()`
`FormDefinitionQueryImpl`	`latestVersion()` Only select the forms which are the latest deployed (ie.
`FormDefinitionQuery`	`orderByDeploymentId()` Order by deployment id (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormDefinitionQuery`	`orderByFormCategory()` Order by the category of the forms (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormDefinitionQuery`	`orderByFormDefinitionKey()` Order by form definition key (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormDefinitionQuery`	`orderByFormId()` Order by the id of the forms (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormDefinitionQuery`	`orderByFormName()` Order by the name of the forms (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormDefinitionQuery`	`orderByFormVersion()` Order by the version of the forms (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormDefinitionQuery`	`orderByTenantId()` Order by tenant id (needs to be followed by `Query.asc()` or `Query.desc()`).

Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery
asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, list, listPage, orderBy, orderBy, setCommandExecutor, singleResult

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
addOrder, buildOrderBy, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getNullHandlingColumn, getOrderBy, getOrderByCollectionSafe, getOrderByForWindow, getOuterJoinOrderBy, getParameter, hasOrderBy, hasOrderByForColumn, isNeedsPaging, mapOrderByToSql, setDatabaseType, setFirstResult, setMaxResults, setNullHandlingColumn, setParameter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.flowable.common.engine.api.query.Query
asc, count, desc, list, listPage, orderBy, orderBy, singleResult

- Field Detail
  - id
```
protected String id
```
  - ids
```
protected Set<String> ids
```
  - category
```
protected String category
```
  - categoryLike
```
protected String categoryLike
```
  - categoryNotEquals
```
protected String categoryNotEquals
```
  - name
```
protected String name
```
  - nameLike
```
protected String nameLike
```
  - deploymentId
```
protected String deploymentId
```
  - deploymentIds
```
protected Set<String> deploymentIds
```
  - key
```
protected String key
```
  - keyLike
```
protected String keyLike
```
  - resourceName
```
protected String resourceName
```
  - resourceNameLike
```
protected String resourceNameLike
```
  - version
```
protected Integer version
```
  - versionGt
```
protected Integer versionGt
```
  - versionGte
```
protected Integer versionGte
```
  - versionLt
```
protected Integer versionLt
```
  - versionLte
```
protected Integer versionLte
```
  - latest
```
protected boolean latest
```
  - tenantId
```
protected String tenantId
```
  - tenantIdLike
```
protected String tenantIdLike
```
  - withoutTenantId
```
protected boolean withoutTenantId
```
- Constructor Detail
  - FormDefinitionQueryImpl
```
public FormDefinitionQueryImpl()
```
  - FormDefinitionQueryImpl
```
public FormDefinitionQueryImpl(CommandContext commandContext)
```
  - FormDefinitionQueryImpl
```
public FormDefinitionQueryImpl(CommandExecutor commandExecutor)
```
- Method Detail
  - formId
```
public FormDefinitionQueryImpl formId(String formId)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select form with the given id.
    
    Specified by:
    
    formId in interface FormDefinitionQuery
  - formIds
```
public FormDefinitionQuery formIds(Set<String> formIds)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms with the given ids.
    
    Specified by:
    
    formIds in interface FormDefinitionQuery
  - formCategory
```
public FormDefinitionQueryImpl formCategory(String category)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms with the given category.
    
    Specified by:
    
    formCategory in interface FormDefinitionQuery
  - formCategoryLike
```
public FormDefinitionQueryImpl formCategoryLike(String categoryLike)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms where the category matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%
    
    Specified by:
    
    formCategoryLike in interface FormDefinitionQuery
  - formCategoryNotEquals
```
public FormDefinitionQueryImpl formCategoryNotEquals(String categoryNotEquals)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select deployments that have a different category then the given one.
    
    Specified by:
    
    formCategoryNotEquals in interface FormDefinitionQuery
    
    See Also:
    
    FormDeploymentBuilder.category(String)
  - formName
```
public FormDefinitionQueryImpl formName(String name)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms with the given name.
    
    Specified by:
    
    formName in interface FormDefinitionQuery
  - formNameLike
```
public FormDefinitionQueryImpl formNameLike(String nameLike)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms where the name matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%
    
    Specified by:
    
    formNameLike in interface FormDefinitionQuery
  - deploymentId
```
public FormDefinitionQueryImpl deploymentId(String deploymentId)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms that are deployed in a deployment with the given deployment id
    
    Specified by:
    
    deploymentId in interface FormDefinitionQuery
  - deploymentIds
```
public FormDefinitionQueryImpl deploymentIds(Set<String> deploymentIds)
```
    Description copied from interface: FormDefinitionQuery
    
    Select forms that are deployed in deployments with the given set of ids
    
    Specified by:
    
    deploymentIds in interface FormDefinitionQuery
  - formDefinitionKey
```
public FormDefinitionQueryImpl formDefinitionKey(String key)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select form with the given key.
    
    Specified by:
    
    formDefinitionKey in interface FormDefinitionQuery
  - formDefinitionKeyLike
```
public FormDefinitionQueryImpl formDefinitionKeyLike(String keyLike)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms where the key matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%
    
    Specified by:
    
    formDefinitionKeyLike in interface FormDefinitionQuery
  - formResourceName
```
public FormDefinitionQueryImpl formResourceName(String resourceName)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select form with the given resource name.
    
    Specified by:
    
    formResourceName in interface FormDefinitionQuery
  - formResourceNameLike
```
public FormDefinitionQueryImpl formResourceNameLike(String resourceNameLike)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select form with a resource name like the given .
    
    Specified by:
    
    formResourceNameLike in interface FormDefinitionQuery
  - formVersion
```
public FormDefinitionQueryImpl formVersion(Integer version)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select form with a certain version. Particularly useful when used in combination with FormDefinitionQuery.formDefinitionKey(String)
    
    Specified by:
    
    formVersion in interface FormDefinitionQuery
  - formVersionGreaterThan
```
public FormDefinitionQuery formVersionGreaterThan(Integer formVersion)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms which version are greater than a certain version.
    
    Specified by:
    
    formVersionGreaterThan in interface FormDefinitionQuery
  - formVersionGreaterThanOrEquals
```
public FormDefinitionQuery formVersionGreaterThanOrEquals(Integer formVersion)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms which version are greater than or equals a certain version.
    
    Specified by:
    
    formVersionGreaterThanOrEquals in interface FormDefinitionQuery
  - formVersionLowerThan
```
public FormDefinitionQuery formVersionLowerThan(Integer formVersion)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms which version are lower than a certain version.
    
    Specified by:
    
    formVersionLowerThan in interface FormDefinitionQuery
  - formVersionLowerThanOrEquals
```
public FormDefinitionQuery formVersionLowerThanOrEquals(Integer formVersion)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms which version are lower than or equals a certain version.
    
    Specified by:
    
    formVersionLowerThanOrEquals in interface FormDefinitionQuery
  - checkVersion
```
protected void checkVersion(Integer version)
```
  - latestVersion
```
public FormDefinitionQueryImpl latestVersion()
```
    Description copied from interface: FormDefinitionQuery
    
    Only select the forms 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 decision tables.
    
    Specified by:
    
    latestVersion in interface FormDefinitionQuery
  - formTenantId
```
public FormDefinitionQuery formTenantId(String tenantId)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms that have the given tenant id.
    
    Specified by:
    
    formTenantId in interface FormDefinitionQuery
  - formTenantIdLike
```
public FormDefinitionQuery formTenantIdLike(String tenantIdLike)
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms with a tenant id like the given one.
    
    Specified by:
    
    formTenantIdLike in interface FormDefinitionQuery
  - formWithoutTenantId
```
public FormDefinitionQuery formWithoutTenantId()
```
    Description copied from interface: FormDefinitionQuery
    
    Only select forms that do not have a tenant id.
    
    Specified by:
    
    formWithoutTenantId in interface FormDefinitionQuery
  - orderByDeploymentId
```
public FormDefinitionQuery orderByDeploymentId()
```
    Description copied from interface: FormDefinitionQuery
    
    Order by deployment id (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByDeploymentId in interface FormDefinitionQuery
  - orderByFormDefinitionKey
```
public FormDefinitionQuery orderByFormDefinitionKey()
```
    Description copied from interface: FormDefinitionQuery
    
    Order by form definition key (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByFormDefinitionKey in interface FormDefinitionQuery
  - orderByFormCategory
```
public FormDefinitionQuery orderByFormCategory()
```
    Description copied from interface: FormDefinitionQuery
    
    Order by the category of the forms (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByFormCategory in interface FormDefinitionQuery
  - orderByFormId
```
public FormDefinitionQuery orderByFormId()
```
    Description copied from interface: FormDefinitionQuery
    
    Order by the id of the forms (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByFormId in interface FormDefinitionQuery
  - orderByFormVersion
```
public FormDefinitionQuery orderByFormVersion()
```
    Description copied from interface: FormDefinitionQuery
    
    Order by the version of the forms (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByFormVersion in interface FormDefinitionQuery
  - orderByFormName
```
public FormDefinitionQuery orderByFormName()
```
    Description copied from interface: FormDefinitionQuery
    
    Order by the name of the forms (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByFormName in interface FormDefinitionQuery
  - orderByTenantId
```
public FormDefinitionQuery orderByTenantId()
```
    Description copied from interface: FormDefinitionQuery
    
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByTenantId in interface FormDefinitionQuery
  - executeCount
```
public long executeCount(CommandContext commandContext)
```
    Specified by:
    
    executeCount in class AbstractQuery<FormDefinitionQuery,FormDefinition>
  - executeList
```
public List<FormDefinition> executeList(CommandContext commandContext)
```
    Description copied from class: AbstractQuery
    
    Executes the actual query to retrieve the list of results.
    
    Specified by:
    
    executeList in class AbstractQuery<FormDefinitionQuery,FormDefinition>
  - 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()
```
  - getKeyLike
```
public String getKeyLike()
```
  - 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()
```
  - getCategoryNotEquals
```
public String getCategoryNotEquals()
```
  - getTenantId
```
public String getTenantId()
```
  - getTenantIdLike
```
public String getTenantIdLike()
```
  - isWithoutTenantId
```
public boolean isWithoutTenantId()
```

Class FormDefinitionQueryImpl

Nested Class Summary

Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query

Field Summary

Fields inherited from class org.flowable.common.engine.impl.query.AbstractQuery

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Constructor Summary

Method Summary

Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.flowable.common.engine.api.query.Query

Field Detail

id

ids

category

categoryLike

categoryNotEquals

name

nameLike

deploymentId

deploymentIds

key

keyLike

resourceName

resourceNameLike

version

versionGt

versionGte

versionLt

versionLte

latest

tenantId

tenantIdLike

withoutTenantId

Constructor Detail

FormDefinitionQueryImpl

FormDefinitionQueryImpl

FormDefinitionQueryImpl

Method Detail

formId

formIds

formCategory

formCategoryLike

formCategoryNotEquals

formName

formNameLike

deploymentId

deploymentIds

formDefinitionKey

formDefinitionKeyLike

formResourceName

formResourceNameLike

formVersion

formVersionGreaterThan

formVersionGreaterThanOrEquals

formVersionLowerThan

formVersionLowerThanOrEquals

checkVersion

latestVersion

formTenantId

formTenantIdLike

formWithoutTenantId

orderByDeploymentId

orderByFormDefinitionKey

orderByFormCategory

orderByFormId

orderByFormVersion

orderByFormName

orderByTenantId

executeCount

executeList

getDeploymentId

getDeploymentIds

getId

getIds

getName

getNameLike

getKey