Interface IPluginFormResourcesFindParams

All Superinterfaces:
Serializable
All Known Implementing Classes:
PluginFormResourcesFindParams
public interface IPluginFormResourcesFindParams extends Serializable
Parameters for the getResources method of a form resources plugin.
Since:
8.5.1
Author:
XIMA MEDIA GmbH

  • Method Summary

    Modifier and Type
    Method
    Description
    FormVersion
    getFormVersion()
    The form version for which to find additional resources, if available.
    Projekt
    getProject()
    The project containing the form version for which to find additional resources, if available.
    EFormRequestType
    getRequestType()
    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.
    Mandant
    getTenant()
    The client who owns the form for which to find additional resources, if available.
    IXForm
    getXForm()
    Gets the form description, as configured in the form designer.
    boolean
    isInline()
     

  • Method Details

    • getFormVersion

      FormVersion getFormVersion()
      The form version for which to find additional resources, if available. 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.
      Returns:
      The form version for which to find additional resources.

    • getProject

      Projekt getProject()
      The project containing the form version for which to find additional resources, if available. May be null when no project is available, e.g. when the user opens a form/provide link without a valid identifier.
      Returns:
      The project containing the form version for which to find additional resources.

    • getRequestType

      EFormRequestType getRequestType()
      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.
      Returns:
      The type of the request for which form resources are needed.

    • getTenant

      Mandant getTenant()
      The client who owns the form for which to find additional resources, if available. May be null when no client is available, e.g. when the user opens a form/provide link without a valid identifier.
      Returns:
      The client who owns the form for which to find additional resources.

    • getXForm

      IXForm getXForm()
      Gets 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.
      Returns:
      The form description, as configured in the form designer.

    • isInline

      boolean isInline()
      Returns:
      Whether the form is rendered inline. In inline mode, all external URLs should be resolved and the data should contain all resources.