Class PluginFormResourcesFindParams.Builder

java.lang.Object
de.xima.fc.plugin.models.params.form.PluginFormResourcesFindParams.Builder
Enclosing class:
PluginFormResourcesFindParams
public static final class PluginFormResourcesFindParams.Builder extends Object
A builder for plugin form resources find parameters.
Since:
8.5.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • build

      public PluginFormResourcesFindParams build()
      Creates a new plugin form resources find parameters instance with the data of this builder.
      Returns:
      A new plugin form resources find parameters instance with the data of this builder.

    • formVersion

      public PluginFormResourcesFindParams.Builder formVersion(FormVersion formVersion)
      Sets the version of the form being rendered.
      Parameters:
      formVersion - The version of the form being rendered.
      Returns:
      This builder for chaining.

    • inline

      public PluginFormResourcesFindParams.Builder inline(boolean inline)
      Sets whether the form is rendered inline.
      Parameters:
      inline - Whether the form is rendered inline.
      Returns:
      This builder for chaining.

    • project

      public PluginFormResourcesFindParams.Builder project(Projekt project)
      Sets the project of the form being rendered.
      Parameters:
      project - The project of the form being rendered.
      Returns:
      This builder for chaining.

    • requestType

      public PluginFormResourcesFindParams.Builder requestType(EFormRequestType requestType)
      Sets the type of the request for which form resources are needed, e.g. whether the form is shown to end users, rendered in the form designer, displayed in the inbox etc.
      Parameters:
      requestType - The type of the request for which form resources are needed.
      Returns:
      This builder for chaining.

    • tenant

      public PluginFormResourcesFindParams.Builder tenant(Mandant tenant)
      Sets the tenant who owns the project.
      Parameters:
      tenant - The tenant who owns the project.
      Returns:
      This builder for chaining.

    • xForm

      public PluginFormResourcesFindParams.Builder xForm(IXForm xForm)
      Sets the form description, as configured in the form designer. May be null when no form version is available, e.g. when the user opens a form/provide link without a valid identifier, or when getting the resources for an HTML response page.
      Parameters:
      xForm - The form description, as configured in the form designer.
      Returns:
      This builder for chaining.