Package org.flowable.form.api

Interface FormRepositoryService

public interface FormRepositoryService
Service providing access to the repository of forms.
Author:
Tijs Rademakers

  • Method Details

    • createDeployment

      FormDeploymentBuilder createDeployment()

    • deleteDeployment

      void deleteDeployment(String deploymentId)
      Deletes the given deployment.
      Parameters:
      deploymentId - id of the deployment, cannot be null.

    • deleteDeployment

      void deleteDeployment(String deploymentId, boolean cascade)
      Deletes the given deployment and cascade deletion to form instances
      Parameters:
      deploymentId - id of the deployment, cannot be null.

    • createFormDefinitionQuery

      FormDefinitionQuery createFormDefinitionQuery()

    • createNativeFormDefinitionQuery

      NativeFormDefinitionQuery createNativeFormDefinitionQuery()

    • setDeploymentCategory

      void setDeploymentCategory(String deploymentId, String category)
      Changes the category of a deployment.
      Parameters:
      deploymentId - The id of the deployment of which the category will be changed.
      category - The new category.

    • setDeploymentTenantId

      void setDeploymentTenantId(String deploymentId, String newTenantId)
      Changes the tenant id of a deployment.
      Parameters:
      deploymentId - The id of the deployment of which the tenant identifier will be changed.
      newTenantId - The new tenant identifier.

    • changeDeploymentParentDeploymentId

      void changeDeploymentParentDeploymentId(String deploymentId, String newParentDeploymentId)
      Changes the parent deployment id of a deployment. This is used to move deployments to a different app deployment parent.
      Parameters:
      deploymentId - The id of the deployment of which the parent deployment identifier will be changed.
      newParentDeploymentId - The new parent deployment identifier.

    • getDeploymentResourceNames

      List<String> getDeploymentResourceNames(String deploymentId)

    • getResourceAsStream

      InputStream getResourceAsStream(String deploymentId, String resourceName)

    • createDeploymentQuery

      FormDeploymentQuery createDeploymentQuery()

    • createNativeDeploymentQuery

      NativeFormDeploymentQuery createNativeDeploymentQuery()

    • getFormDefinition

      FormDefinition getFormDefinition(String formDefinitionId)

    • getFormModelById

      FormInfo getFormModelById(String formDefinitionId)

    • getFormModelByKey

      FormInfo getFormModelByKey(String formDefinitionKey)

    • getFormModelByKey

      FormInfo getFormModelByKey(String formDefinitionKey, String tenantId, boolean fallbackToDefaultTenant)

    • getFormModelByKeyAndParentDeploymentId

      FormInfo getFormModelByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId)

    • getFormModelByKeyAndParentDeploymentId

      FormInfo getFormModelByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String tenantId, boolean fallbackToDefaultTenant)

    • getFormDefinitionResource

      InputStream getFormDefinitionResource(String formDefinitionId)

    • setFormDefinitionCategory

      void setFormDefinitionCategory(String formDefinitionId, String category)