Interface IPluginDataSourceParams

All Superinterfaces:
IPluginParameters, Serializable
All Known Implementing Classes:
DatenquelleParams
public interface IPluginDataSourceParams extends IPluginParameters, Serializable
Interface that encapsulates the parameters for a data source plugin.
Author:
XIMA MEDIA GmbH

  • Method Details

    • getMandant

      Mandant getMandant()
      Returns:
      The Mandant client to which the current form belongs to.

    • getSessionAttributeMap

      Map<String, Serializable> getSessionAttributeMap()
      Returns:
      A Map with attributes of the current form session.
      Since:
      5.0

    • getProjekt

      Projekt getProjekt()
      Returns:
      The Projekt that contains the form.

    • getFormRequestType

      EFormRequestType getFormRequestType()
      The type of the current form request. This can be used to determine the context in which the form is opened.
      Returns:
      The type of the current form request.

    • getFormRecord

      Vorgang getFormRecord()
      The current form record, if any exists. E.g. when the form is opened initially, no form record is available.
      Returns:
      The current form record, or null if no form record is available.

    • getRequestParameters

      ValueParameters getRequestParameters()
      Getters for the parameters of the HTTP request. They are grouped into several categories, according to their type, which is determined by the prefix of the HTTP parameter.
      Returns:
      The ValueParameters representing the request parameters of the current form request.

    • getUser

      IUser getUser()
      Returns:
      the user that is authenticated in the session.
      Since:
      7.1

    • getUserData

      com.alibaba.fastjson.JSONObject getUserData()
      Returns:
      A JSONObject with the data for the authenticated user. When the current form does not require authorization, or when the current user did not authorize via this may return null.
      Since:
      6.1

    • getCurrentUser

      @Deprecated Benutzer getCurrentUser()
      Deprecated.
      Use getUser() instead.
      Returns:
      The current Benutzer who is signed in to formcycle.
      Since:
      6.1

    • getLdapUserData

      @Deprecated com.alibaba.fastjson.JSONObject getLdapUserData()
      Deprecated.
      use getUserData()

    • getSessionAttributes

      @Deprecated SessionAttributes getSessionAttributes()
      Deprecated.
      Use getSessionAttributeMap().