Package org.flowable.form.api

Interface FormDeploymentQuery

All Superinterfaces:

Query<FormDeploymentQuery,FormDeployment>

public interface FormDeploymentQuery
extends Query<FormDeploymentQuery,FormDeployment>

Allows programmatic querying of FormDeployments. Note that it is impossible to retrieve the deployment resources through the results of this operation, since that would cause a huge transfer of (possibly) unneeded bytes over the wire. To retrieve the actual bytes of a deployment resource use the operations on the FormRepositoryService.getDeploymentResourceNames(String) and FormRepositoryService.getResourceAsStream(String, String)

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
FormDeploymentQuery	deploymentCategory(String category)	Only select deployments with the given category.
FormDeploymentQuery	deploymentCategoryNotEquals(String categoryNotEquals)	Only select deployments that have a different category then the given one.
FormDeploymentQuery	deploymentId(String deploymentId)	Only select deployments with the given deployment id.
FormDeploymentQuery	deploymentName(String name)	Only select deployments with the given name.
FormDeploymentQuery	deploymentNameLike(String nameLike)	Only select deployments with a name like the given string.
FormDeploymentQuery	deploymentTenantId(String tenantId)	Only select deployment that have the given tenant id.
FormDeploymentQuery	deploymentTenantIdLike(String tenantIdLike)	Only select deployments with a tenant id like the given one.
FormDeploymentQuery	deploymentWithoutTenantId()	Only select deployments that do not have a tenant id.
FormDeploymentQuery	formDefinitionKey(String key)	Only select deployments with the given form definition key.
FormDeploymentQuery	formDefinitionKeyLike(String keyLike)	Only select deployments with a form definition key like the given string.
FormDeploymentQuery	orderByDeploymentId()	Order by deployment id (needs to be followed by Query.asc() or Query.desc()).
FormDeploymentQuery	orderByDeploymentName()	Order by deployment name (needs to be followed by Query.asc() or Query.desc()).
FormDeploymentQuery	orderByDeploymentTime()	Order by deployment time (needs to be followed by Query.asc() or Query.desc()).
FormDeploymentQuery	orderByTenantId()	Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
FormDeploymentQuery	parentDeploymentId(String deploymentParentId)	Only select deployment that have the given deployment parent id.
FormDeploymentQuery	parentDeploymentIdLike(String deploymentParentIdLike)	Only select deployments with a deployment parent id like the given one.

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

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

Method Details

deploymentId

FormDeploymentQuery deploymentId(String deploymentId)

Only select deployments with the given deployment id.

deploymentName

FormDeploymentQuery deploymentName(String name)

Only select deployments with the given name.

deploymentNameLike

FormDeploymentQuery deploymentNameLike(String nameLike)

Only select deployments with a name like the given string.

deploymentCategory

FormDeploymentQuery deploymentCategory(String category)

Only select deployments with the given category.

See Also:

• FormDeploymentBuilder.category(String)

deploymentCategoryNotEquals

FormDeploymentQuery deploymentCategoryNotEquals(String categoryNotEquals)

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

See Also:

• FormDeploymentBuilder.category(String)

deploymentTenantId

FormDeploymentQuery deploymentTenantId(String tenantId)

Only select deployment that have the given tenant id.

deploymentTenantIdLike

FormDeploymentQuery deploymentTenantIdLike(String tenantIdLike)

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

deploymentWithoutTenantId

FormDeploymentQuery deploymentWithoutTenantId()

Only select deployments that do not have a tenant id.

formDefinitionKey

FormDeploymentQuery formDefinitionKey(String key)

Only select deployments with the given form definition key.

formDefinitionKeyLike

FormDeploymentQuery formDefinitionKeyLike(String keyLike)

Only select deployments with a form definition key like the given string.

parentDeploymentId

FormDeploymentQuery parentDeploymentId(String deploymentParentId)

Only select deployment that have the given deployment parent id.

parentDeploymentIdLike

FormDeploymentQuery parentDeploymentIdLike(String deploymentParentIdLike)

Only select deployments with a deployment parent id like the given one.

orderByDeploymentId

FormDeploymentQuery orderByDeploymentId()

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

orderByDeploymentName

FormDeploymentQuery orderByDeploymentName()

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

orderByDeploymentTime

FormDeploymentQuery orderByDeploymentTime()

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

orderByTenantId

FormDeploymentQuery orderByTenantId()

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