de.xima.fc.interfaces.plugin.param.form

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, Dresden - Michael Kohlsche - 21.08.2015

Method Summary

Modifier and Type	Method and Description
Benutzer	getCurrentUser()
com.alibaba.fastjson.JSONObject	getLdapUserData()
Mandant	getMandant()
Projekt	getProjekt()
ValueParameters	getRequestParameters() Getters for the parameters of the HTTP request.
Map<String,Serializable>	getSessionAttributeMap()
SessionAttributes	getSessionAttributes() Deprecated. Use getSessionAttributeMap().

Method Detail

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.

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.

getCurrentUser

Benutzer getCurrentUser()

Returns:

The current Benutzer who is signed in to FORMCYCLE.

Since:

6.1

getLdapUserData

com.alibaba.fastjson.JSONObject getLdapUserData()

Returns:

A JSONObject with the current LDAP data for the authenticated user. When the current form does not require authorization, or when the current user did not authorize via LDAP, this may return null.

Since:

6.1

getSessionAttributes

@Deprecated
SessionAttributes getSessionAttributes()

Deprecated. Use getSessionAttributeMap().