Package org.flowable.form.api
Interface FormDefinitionQuery
-
- All Superinterfaces:
Query<FormDefinitionQuery,FormDefinition>
public interface FormDefinitionQuery extends Query<FormDefinitionQuery,FormDefinition>
Allows programmatic querying ofFormDefinitions.- 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FormDefinitionQuerydeploymentId(String deploymentId)Only select forms that are deployed in a deployment with the given deployment idFormDefinitionQuerydeploymentIds(Set<String> deploymentIds)Select forms that are deployed in deployments with the given set of idsFormDefinitionQueryformCategory(String formCategory)Only select forms with the given category.FormDefinitionQueryformCategoryLike(String formCategoryLike)Only select forms where the category matches the given parameter.FormDefinitionQueryformCategoryNotEquals(String categoryNotEquals)Only select deployments that have a different category then the given one.FormDefinitionQueryformDefinitionKey(String formDefinitionKey)Only select form with the given key.FormDefinitionQueryformDefinitionKeyLike(String formDefinitionKeyLike)Only select forms where the key matches the given parameter.FormDefinitionQueryformId(String formId)Only select form with the given id.FormDefinitionQueryformIds(Set<String> formIds)Only select forms with the given ids.FormDefinitionQueryformName(String formName)Only select forms with the given name.FormDefinitionQueryformNameLike(String formNameLike)Only select forms where the name matches the given parameter.FormDefinitionQueryformResourceName(String resourceName)Only select form with the given resource name.FormDefinitionQueryformResourceNameLike(String resourceNameLike)Only select form with a resource name like the given .FormDefinitionQueryformTenantId(String tenantId)Only select forms that have the given tenant id.FormDefinitionQueryformTenantIdLike(String tenantIdLike)Only select forms with a tenant id like the given one.FormDefinitionQueryformVersion(Integer formVersion)Only select form with a certain version.FormDefinitionQueryformVersionGreaterThan(Integer formVersion)Only select forms which version are greater than a certain version.FormDefinitionQueryformVersionGreaterThanOrEquals(Integer formVersion)Only select forms which version are greater than or equals a certain version.FormDefinitionQueryformVersionLowerThan(Integer formVersion)Only select forms which version are lower than a certain version.FormDefinitionQueryformVersionLowerThanOrEquals(Integer formVersion)Only select forms which version are lower than or equals a certain version.FormDefinitionQueryformWithoutTenantId()Only select forms that do not have a tenant id.FormDefinitionQuerylatestVersion()Only select the forms which are the latest deployed (ie.FormDefinitionQueryorderByDeploymentId()Order by deployment id (needs to be followed byQuery.asc()orQuery.desc()).FormDefinitionQueryorderByFormCategory()Order by the category of the forms (needs to be followed byQuery.asc()orQuery.desc()).FormDefinitionQueryorderByFormDefinitionKey()Order by form definition key (needs to be followed byQuery.asc()orQuery.desc()).FormDefinitionQueryorderByFormId()Order by the id of the forms (needs to be followed byQuery.asc()orQuery.desc()).FormDefinitionQueryorderByFormName()Order by the name of the forms (needs to be followed byQuery.asc()orQuery.desc()).FormDefinitionQueryorderByFormVersion()Order by the version of the forms (needs to be followed byQuery.asc()orQuery.desc()).FormDefinitionQueryorderByTenantId()Order by tenant id (needs to be followed byQuery.asc()orQuery.desc()).FormDefinitionQueryparentDeploymentId(String parentDeploymentId)Only select forms that are deployed in a deployment with the given parent deployment id
-
-
-
Method Detail
-
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 withformDefinitionKey(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 withformVersion(Integer)ordeploymentId(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 byQuery.asc()orQuery.desc()).
-
orderByFormDefinitionKey
FormDefinitionQuery orderByFormDefinitionKey()
Order by form definition key (needs to be followed byQuery.asc()orQuery.desc()).
-
orderByFormId
FormDefinitionQuery orderByFormId()
Order by the id of the forms (needs to be followed byQuery.asc()orQuery.desc()).
-
orderByFormVersion
FormDefinitionQuery orderByFormVersion()
Order by the version of the forms (needs to be followed byQuery.asc()orQuery.desc()).
-
orderByFormName
FormDefinitionQuery orderByFormName()
Order by the name of the forms (needs to be followed byQuery.asc()orQuery.desc()).
-
orderByDeploymentId
FormDefinitionQuery orderByDeploymentId()
Order by deployment id (needs to be followed byQuery.asc()orQuery.desc()).
-
orderByTenantId
FormDefinitionQuery orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()orQuery.desc()).
-
-