Package org.flowable.form.api

Interface FormDefinitionQuery

All Superinterfaces:

Query<FormDefinitionQuery,FormDefinition>

public interface FormDefinitionQuery
extends Query<FormDefinitionQuery,FormDefinition>

Allows programmatic querying of FormDefinitions.

Author:

Tijs Rademakers, Joram Barrez

Nested Class Summary

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

Query.NullHandlingOnOrder

Method Summary

Modifier and Type	Method	Description
FormDefinitionQuery	deploymentId(String deploymentId)	Only select forms that are deployed in a deployment with the given deployment id
FormDefinitionQuery	deploymentIds(Set<String> deploymentIds)	Select forms that are deployed in deployments with the given set of ids
FormDefinitionQuery	formCategory(String formCategory)	Only select forms with the given category.
FormDefinitionQuery	formCategoryLike(String formCategoryLike)	Only select forms where the category matches the given parameter.
FormDefinitionQuery	formCategoryNotEquals(String categoryNotEquals)	Only select deployments that have a different category then the given one.
FormDefinitionQuery	formDefinitionKey(String formDefinitionKey)	Only select form with the given key.
FormDefinitionQuery	formDefinitionKeyLike(String formDefinitionKeyLike)	Only select forms where the key matches the given parameter.
FormDefinitionQuery	formId(String formId)	Only select form with the given id.
FormDefinitionQuery	formIds(Set<String> formIds)	Only select forms with the given ids.
FormDefinitionQuery	formName(String formName)	Only select forms with the given name.
FormDefinitionQuery	formNameLike(String formNameLike)	Only select forms where the name matches the given parameter.
FormDefinitionQuery	formResourceName(String resourceName)	Only select form with the given resource name.
FormDefinitionQuery	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.
FormDefinitionQuery	formVersion(Integer formVersion)	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.
FormDefinitionQuery	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()).
FormDefinitionQuery	parentDeploymentId(String parentDeploymentId)	Only select forms that are deployed in a deployment with the given parent deployment id

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

asc, count, desc, list, listPage, orderBy, orderBy, singleResult

Method Details

formId

FormDefinitionQuery formId(String formId)

Only select form with the given id.

formIds

FormDefinitionQuery formIds(Set<String> formIds)

Only select forms with the given ids.

formCategory

FormDefinitionQuery formCategory(String formCategory)

Only select forms with the given category.

formCategoryLike

FormDefinitionQuery 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. %test%

formCategoryNotEquals

FormDefinitionQuery formCategoryNotEquals(String categoryNotEquals)

Only select deployments that have a different category then the given one.

See Also:

• FormDeploymentBuilder.category(String)

formName

FormDefinitionQuery formName(String formName)

Only select forms with the given name.

formNameLike

FormDefinitionQuery 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. %test%

deploymentId

FormDefinitionQuery deploymentId(String deploymentId)

Only select forms that are deployed in a deployment with the given deployment id

deploymentIds

FormDefinitionQuery deploymentIds(Set<String> deploymentIds)

Select forms that are deployed in deployments with the given set of ids

parentDeploymentId

FormDefinitionQuery parentDeploymentId(String parentDeploymentId)

Only select forms that are deployed in a deployment with the given parent deployment id

formDefinitionKey

FormDefinitionQuery formDefinitionKey(String formDefinitionKey)

Only select form with the given key.

formDefinitionKeyLike

FormDefinitionQuery 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. %test%

formVersion

FormDefinitionQuery formVersion(Integer formVersion)

Only select form with a certain version. Particularly useful when used in combination with formDefinitionKey(String)

formVersionGreaterThan

FormDefinitionQuery formVersionGreaterThan(Integer formVersion)

Only select forms which version are greater than a certain version.

formVersionGreaterThanOrEquals

FormDefinitionQuery formVersionGreaterThanOrEquals(Integer formVersion)

Only select forms which version are greater than or equals a certain version.

formVersionLowerThan

FormDefinitionQuery formVersionLowerThan(Integer formVersion)

Only select forms which version are lower than a certain version.

formVersionLowerThanOrEquals

FormDefinitionQuery formVersionLowerThanOrEquals(Integer formVersion)

Only select forms which version are lower than or equals a certain version.

latestVersion

FormDefinitionQuery 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 form definitions.

Throws:

FlowableIllegalArgumentException - if used in combination with formVersion(Integer) or deploymentId(String)

formResourceName

FormDefinitionQuery formResourceName(String resourceName)

Only select form with the given resource name.

formResourceNameLike

FormDefinitionQuery formResourceNameLike(String resourceNameLike)

Only select form with a resource name like the given .

formTenantId

FormDefinitionQuery formTenantId(String tenantId)

Only select forms that have the given tenant id.

formTenantIdLike

FormDefinitionQuery formTenantIdLike(String tenantIdLike)

Only select forms with a tenant id like the given one.

formWithoutTenantId

FormDefinitionQuery formWithoutTenantId()

Only select forms that do not have a tenant id.

orderByFormCategory

FormDefinitionQuery orderByFormCategory()

Order by the category of the forms (needs to be followed by Query.asc() or Query.desc()).

orderByFormDefinitionKey

FormDefinitionQuery orderByFormDefinitionKey()

Order by form definition key (needs to be followed by Query.asc() or Query.desc()).

orderByFormId

FormDefinitionQuery orderByFormId()

Order by the id of the forms (needs to be followed by Query.asc() or Query.desc()).

orderByFormVersion

FormDefinitionQuery orderByFormVersion()

Order by the version of the forms (needs to be followed by Query.asc() or Query.desc()).

orderByFormName

FormDefinitionQuery orderByFormName()

Order by the name of the forms (needs to be followed by Query.asc() or Query.desc()).

orderByDeploymentId

FormDefinitionQuery orderByDeploymentId()

Order by deployment id (needs to be followed by Query.asc() or Query.desc()).

orderByTenantId

FormDefinitionQuery orderByTenantId()

Order by tenant id (needs to be followed by Query.asc() or Query.desc()).