FormQuery (Activiti - Form API 6.0.0 API)

All Superinterfaces:

Query<FormQuery,Form>
```
public interface FormQuery
extends Query<FormQuery,Form>
```
Allows programmatic querying of Forms.

Author:

Tijs Rademakers, Joram Barrez

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`FormQuery`	`deploymentId(String deploymentId)` Only select forms that are deployed in a deployment with the given deployment id
`FormQuery`	`deploymentIds(Set<String> deploymentIds)` Select forms that are deployed in deployments with the given set of ids
`FormQuery`	`formCategory(String formCategory)` Only select forms with the given category.
`FormQuery`	`formCategoryLike(String formCategoryLike)` Only select forms where the category matches the given parameter.
`FormQuery`	`formCategoryNotEquals(String categoryNotEquals)` Only select deployments that have a different category then the given one.
`FormQuery`	`formDefinitionKey(String formDefinitionKey)` Only select form with the given key.
`FormQuery`	`formDefinitionKeyLike(String formDefinitionKeyLike)` Only select forms where the key matches the given parameter.
`FormQuery`	`formId(String formId)` Only select form with the given id.
`FormQuery`	`formIds(Set<String> formIds)` Only select forms with the given ids.
`FormQuery`	`formName(String formName)` Only select forms with the given name.
`FormQuery`	`formNameLike(String formNameLike)` Only select forms where the name matches the given parameter.
`FormQuery`	`formResourceName(String resourceName)` Only select form with the given resource name.
`FormQuery`	`formResourceNameLike(String resourceNameLike)` Only select form with a resource name like the given .
`FormQuery`	`formTenantId(String tenantId)` Only select forms that have the given tenant id.
`FormQuery`	`formTenantIdLike(String tenantIdLike)` Only select forms with a tenant id like the given one.
`FormQuery`	`formVersion(Integer formVersion)` Only select form with a certain version.
`FormQuery`	`formVersionGreaterThan(Integer formVersion)` Only select forms which version are greater than a certain version.
`FormQuery`	`formVersionGreaterThanOrEquals(Integer formVersion)` Only select forms which version are greater than or equals a certain version.
`FormQuery`	`formVersionLowerThan(Integer formVersion)` Only select forms which version are lower than a certain version.
`FormQuery`	`formVersionLowerThanOrEquals(Integer formVersion)` Only select forms which version are lower than or equals a certain version.
`FormQuery`	`formWithoutTenantId()` Only select forms that do not have a tenant id.
`FormQuery`	`latestVersion()` Only select the forms which are the latest deployed (ie.
`FormQuery`	`orderByDeploymentId()` Order by deployment id (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormQuery`	`orderByFormCategory()` Order by the category of the forms (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormQuery`	`orderByFormDefinitionKey()` Order by form definition key (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormQuery`	`orderByFormId()` Order by the id of the forms (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormQuery`	`orderByFormName()` Order by the name of the forms (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormQuery`	`orderByFormVersion()` Order by the version of the forms (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormQuery`	`orderByTenantId()` Order by tenant id (needs to be followed by `Query.asc()` or `Query.desc()`).
`FormQuery`	`parentDeploymentId(String parentDeploymentId)` Only select forms that have the given parent deployment id
`FormQuery`	`parentDeploymentIdLike(String parentDeploymentIdLike)` Only select forms that have a parent deployment id like the given parameter

Methods inherited from interface org.activiti.form.api.Query
asc, count, desc, list, listPage, singleResult

- Method Detail
  - formId
```
FormQuery formId(String formId)
```
    Only select form with the given id.
  - formIds
```
FormQuery formIds(Set<String> formIds)
```
    Only select forms with the given ids.
  - formCategory
```
FormQuery formCategory(String formCategory)
```
    Only select forms with the given category.
  - formCategoryLike
```
FormQuery formCategoryLike(String formCategoryLike)
```
    Only select forms where the category matches the given parameter. The syntax that should be used is the same as in SQL, eg. %activiti%
  - formCategoryNotEquals
```
FormQuery formCategoryNotEquals(String categoryNotEquals)
```
    Only select deployments that have a different category then the given one.
    
    See Also:
    
    DeploymentBuilder#category(String)
  - formName
```
FormQuery formName(String formName)
```
    Only select forms with the given name.
  - formNameLike
```
FormQuery formNameLike(String formNameLike)
```
    Only select forms where the name matches the given parameter. The syntax that should be used is the same as in SQL, eg. %activiti%
  - deploymentId
```
FormQuery deploymentId(String deploymentId)
```
    Only select forms that are deployed in a deployment with the given deployment id
  - deploymentIds
```
FormQuery deploymentIds(Set<String> deploymentIds)
```
    Select forms that are deployed in deployments with the given set of ids
  - parentDeploymentId
```
FormQuery parentDeploymentId(String parentDeploymentId)
```
    Only select forms that have the given parent deployment id
  - parentDeploymentIdLike
```
FormQuery parentDeploymentIdLike(String parentDeploymentIdLike)
```
    Only select forms that have a parent deployment id like the given parameter
  - formDefinitionKey
```
FormQuery formDefinitionKey(String formDefinitionKey)
```
    Only select form with the given key.
  - formDefinitionKeyLike
```
FormQuery formDefinitionKeyLike(String formDefinitionKeyLike)
```
    Only select forms where the key matches the given parameter. The syntax that should be used is the same as in SQL, eg. %activiti%
  - formVersion
```
FormQuery formVersion(Integer formVersion)
```
    Only select form with a certain version. Particularly useful when used in combination with formDefinitionKey(String)
  - formVersionGreaterThan
```
FormQuery formVersionGreaterThan(Integer formVersion)
```
    Only select forms which version are greater than a certain version.
  - formVersionGreaterThanOrEquals
```
FormQuery formVersionGreaterThanOrEquals(Integer formVersion)
```
    Only select forms which version are greater than or equals a certain version.
  - formVersionLowerThan
```
FormQuery formVersionLowerThan(Integer formVersion)
```
    Only select forms which version are lower than a certain version.
  - formVersionLowerThanOrEquals
```
FormQuery formVersionLowerThanOrEquals(Integer formVersion)
```
    Only select forms which version are lower than or equals a certain version.
  - latestVersion
```
FormQuery latestVersion()
```
    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.
    
    Throws:
    
    ActivitiIllegalArgumentException - if used in combination with #groupId(string), #formVersion(int) or deploymentId(String)
  - formResourceName
```
FormQuery formResourceName(String resourceName)
```
    Only select form with the given resource name.
  - formResourceNameLike
```
FormQuery formResourceNameLike(String resourceNameLike)
```
    Only select form with a resource name like the given .
  - formTenantId
```
FormQuery formTenantId(String tenantId)
```
    Only select forms that have the given tenant id.
  - formTenantIdLike
```
FormQuery formTenantIdLike(String tenantIdLike)
```
    Only select forms with a tenant id like the given one.
  - formWithoutTenantId
```
FormQuery formWithoutTenantId()
```
    Only select forms that do not have a tenant id.
  - orderByFormCategory
```
FormQuery orderByFormCategory()
```
    Order by the category of the forms (needs to be followed by Query.asc() or Query.desc()).
  - orderByFormDefinitionKey
```
FormQuery orderByFormDefinitionKey()
```
    Order by form definition key (needs to be followed by Query.asc() or Query.desc()).
  - orderByFormId
```
FormQuery orderByFormId()
```
    Order by the id of the forms (needs to be followed by Query.asc() or Query.desc()).
  - orderByFormVersion
```
FormQuery orderByFormVersion()
```
    Order by the version of the forms (needs to be followed by Query.asc() or Query.desc()).
  - orderByFormName
```
FormQuery orderByFormName()
```
    Order by the name of the forms (needs to be followed by Query.asc() or Query.desc()).
  - orderByDeploymentId
```
FormQuery orderByDeploymentId()
```
    Order by deployment id (needs to be followed by Query.asc() or Query.desc()).
  - orderByTenantId
```
FormQuery orderByTenantId()
```
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()).

Interface FormQuery

Method Summary

Methods inherited from interface org.activiti.form.api.Query

Method Detail

formId

formIds

formCategory

formCategoryLike

formCategoryNotEquals

formName

formNameLike

deploymentId

deploymentIds

parentDeploymentId

parentDeploymentIdLike

formDefinitionKey

formDefinitionKeyLike

formVersion

formVersionGreaterThan

formVersionGreaterThanOrEquals

formVersionLowerThan

formVersionLowerThanOrEquals

latestVersion

formResourceName

formResourceNameLike

formTenantId

formTenantIdLike

formWithoutTenantId

orderByFormCategory

orderByFormDefinitionKey

orderByFormId

orderByFormVersion

orderByFormName

orderByDeploymentId

orderByTenantId