org.flowable.form.api

Interface FormDeploymentBuilder

public interface FormDeploymentBuilder

Builder for creating new deployments. A builder instance can be obtained through FormRepositoryService.createDeployment(). Multiple resources can be added to one deployment before calling the deploy() operation. After deploying, no more changes can be made to the returned deployment and the builder instance can be disposed.

Author:

Tijs Rademakers, Joram Barrez

Method Summary

Modifier and Type	Method and Description
FormDeploymentBuilder	addClasspathResource(String resource)
FormDeploymentBuilder	addFormBytes(String resourceName, byte[] formBytes)
FormDeploymentBuilder	addFormDefinition(String resourceName, String formDefinition)
FormDeploymentBuilder	addInputStream(String resourceName, InputStream inputStream)
FormDeploymentBuilder	addString(String resourceName, String text)
FormDeploymentBuilder	category(String category) Gives the deployment the given category.
FormDeployment	deploy() Deploys all provided sources to the Flowable engine.
FormDeploymentBuilder	enableDuplicateFiltering() Allows to add a property to the deployment builder that influences the deployment.
FormDeploymentBuilder	name(String name) Gives the deployment the given name.
FormDeploymentBuilder	parentDeploymentId(String parentDeploymentId) Gives the deployment the given parent deployment id.
FormDeploymentBuilder	tenantId(String tenantId) Gives the deployment the given tenant id.

Method Detail

addInputStream

FormDeploymentBuilder addInputStream(String resourceName,
                                     InputStream inputStream)

addClasspathResource

FormDeploymentBuilder addClasspathResource(String resource)

addString

FormDeploymentBuilder addString(String resourceName,
                                String text)

addFormBytes

FormDeploymentBuilder addFormBytes(String resourceName,
                                   byte[] formBytes)

addFormDefinition

FormDeploymentBuilder addFormDefinition(String resourceName,
                                        String formDefinition)

name

FormDeploymentBuilder name(String name)

Gives the deployment the given name.

category

FormDeploymentBuilder category(String category)

Gives the deployment the given category.

tenantId

FormDeploymentBuilder tenantId(String tenantId)

Gives the deployment the given tenant id.

parentDeploymentId

FormDeploymentBuilder parentDeploymentId(String parentDeploymentId)

Gives the deployment the given parent deployment id.

enableDuplicateFiltering

FormDeploymentBuilder enableDuplicateFiltering()

Allows to add a property to the deployment builder that influences the deployment.

deploy

FormDeployment deploy()

Deploys all provided sources to the Flowable engine.