Class DatenquelleParams

java.lang.Object

de.xima.fc.web.common.datasource.DatenquelleParams

All Implemented Interfaces:

IDatenquelleParams, IPluginParameters, IPluginDataSourceParams, Serializable

public class DatenquelleParams
extends Object
implements IDatenquelleParams, IPluginDataSourceParams

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DatenquelleParams.Builder

Constructor Summary

Constructors

Constructor	Description
DatenquelleParams(Mandant mandant, Map<String, Serializable> sessionAttributes, ValueParameters requestParameters, Projekt projekt)	Deprecated.
DatenquelleParams(Mandant mandant, Map<String, Serializable> sessionAttributes, ValueParameters requestParameters, Projekt projekt, Benutzer user, com.alibaba.fastjson.JSONObject userData)	Deprecated.
DatenquelleParams(Mandant mandant, Map<String, Serializable> sessionAttributes, ValueParameters requestParameters, Projekt projekt, IUser user, com.alibaba.fastjson.JSONObject userData)	Deprecated.
DatenquelleParams(XItem item, Mandant mandant, SessionAttributes sessionAttributes, ValueParameters requestParameters, Projekt projekt)	Deprecated.
DatenquelleParams(XItem item, Mandant mandant, Map<String, Serializable> sessionAttributes, ValueParameters requestParameters, Projekt projekt)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static DatenquelleParams.Builder	builder()
Benutzer	getCurrentUser()	Deprecated. Use getUser() instead.
Vorgang	getFormRecord()	The current form record, if any exists.
EFormRequestType	getFormRequestType()	The type of the current form request.
XItem	getItem()	Deprecated.
com.alibaba.fastjson.JSONObject	getLdapUserData()	Deprecated.
Mandant	getMandant()	Der Mandant in welchem sich das Formular befindet
Projekt	getProjekt()	Das Projekt welches das Formular bereitstellt
ValueParameters	getRequestParameters()	Getter für aufbereitete Request-Parameter welche je nach typ (Prefix) in entsprechende Maps sortiert sind.
Map<String, Serializable>	getSessionAttributeMap()	In der Formular-Sitzung serialisierbare Session-Attribute
SessionAttributes	getSessionAttributes()	Deprecated.
IUser	getUser()
com.alibaba.fastjson.JSONObject	getUserData()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DatenquelleParams

@Deprecated
public DatenquelleParams(Mandant mandant,
 Map<String, Serializable> sessionAttributes,
 ValueParameters requestParameters,
 Projekt projekt)

Deprecated.

Use builder() instead.

Parameters:

mandant - The client owning the form.

sessionAttributes - The form request session attributes.

requestParameters - The form request parameters.

projekt - The project.

DatenquelleParams

@Deprecated
public DatenquelleParams(Mandant mandant,
 Map<String, Serializable> sessionAttributes,
 ValueParameters requestParameters,
 Projekt projekt,
 IUser user,
 com.alibaba.fastjson.JSONObject userData)

Deprecated.

Use builder() instead.

Parameters:

mandant - The client owning the form.

sessionAttributes - The form request session attributes.

requestParameters - The form request parameters.

projekt - The project.

user - The authenticated user.

userData - The data of the authenticated user.

DatenquelleParams

@Deprecated
public DatenquelleParams(Mandant mandant,
 Map<String, Serializable> sessionAttributes,
 ValueParameters requestParameters,
 Projekt projekt,
 Benutzer user,
 com.alibaba.fastjson.JSONObject userData)

Deprecated.

Use builder() instead.

Parameters:

mandant - The client owning the form.

sessionAttributes - The form request session attributes.

requestParameters - The form request parameters.

projekt - The project.

user - The authenticated user.

userData - The data of the authenticated user.

DatenquelleParams

@Deprecated
public DatenquelleParams(XItem item,
 Mandant mandant,
 SessionAttributes sessionAttributes,
 ValueParameters requestParameters,
 Projekt projekt)

Deprecated.

Use builder() instead.

Parameters:

item - The form item for which the data source is requested.

mandant - The client owning the form.

sessionAttributes - The form request session attributes.

requestParameters - The form request parameters.

projekt - The project.

DatenquelleParams

@Deprecated
public DatenquelleParams(XItem item,
 Mandant mandant,
 Map<String, Serializable> sessionAttributes,
 ValueParameters requestParameters,
 Projekt projekt)

Deprecated.

Use builder() instead.

Parameters:

item - The form item for which the data source is requested.

mandant - The client owning the form.

sessionAttributes - The form request session attributes.

requestParameters - The form request parameters.

projekt - The project.

Method Details

getCurrentUser

@Deprecated
public Benutzer getCurrentUser()

Deprecated.

Use getUser() instead.

Specified by:

getCurrentUser in interface IPluginDataSourceParams

Returns:

The current Benutzer who is signed in to formcycle.

getFormRecord

public Vorgang getFormRecord()

Description copied from interface: IPluginDataSourceParams

The current form record, if any exists. E.g. when the form is opened initially, no form record is available.

Specified by:

getFormRecord in interface IPluginDataSourceParams

Returns:

The current form record, or null if no form record is available.

getFormRequestType

public EFormRequestType getFormRequestType()

Description copied from interface: IPluginDataSourceParams

The type of the current form request. This can be used to determine the context in which the form is opened.

Specified by:

getFormRequestType in interface IPluginDataSourceParams

Returns:

The type of the current form request.

getItem

@Deprecated
public XItem getItem()

Deprecated.

Description copied from interface: IDatenquelleParams

Das Formular-Feld von welchem die Datenquelle benutzt wird

Specified by:

getItem in interface IDatenquelleParams

Returns:

XItem

getLdapUserData

@Deprecated
public com.alibaba.fastjson.JSONObject getLdapUserData()

Deprecated.

Specified by:

getLdapUserData in interface IPluginDataSourceParams

getMandant

public Mandant getMandant()

Description copied from interface: IDatenquelleParams

Der Mandant in welchem sich das Formular befindet

Specified by:

getMandant in interface IDatenquelleParams

Specified by:

getMandant in interface IPluginDataSourceParams

Returns:

Mandant

getProjekt

public Projekt getProjekt()

Description copied from interface: IDatenquelleParams

Das Projekt welches das Formular bereitstellt

Specified by:

getProjekt in interface IDatenquelleParams

Specified by:

getProjekt in interface IPluginDataSourceParams

Returns:

Process

getRequestParameters

public ValueParameters getRequestParameters()

Description copied from interface: IDatenquelleParams

Getter für aufbereitete Request-Parameter welche je nach typ (Prefix) in entsprechende Maps sortiert sind.

Specified by:

getRequestParameters in interface IDatenquelleParams

Specified by:

getRequestParameters in interface IPluginDataSourceParams

Returns:

ValueParameters

getSessionAttributeMap

public Map<String, Serializable> getSessionAttributeMap()

Description copied from interface: IDatenquelleParams

In der Formular-Sitzung serialisierbare Session-Attribute

Specified by:

getSessionAttributeMap in interface IDatenquelleParams

Specified by:

getSessionAttributeMap in interface IPluginDataSourceParams

Returns:

SessionAttributes

getSessionAttributes

@Deprecated
public SessionAttributes getSessionAttributes()

Deprecated.

Specified by:

getSessionAttributes in interface IDatenquelleParams

Specified by:

getSessionAttributes in interface IPluginDataSourceParams

getUser

public IUser getUser()

Specified by:

getUser in interface IPluginDataSourceParams

Returns:

the user that is authenticated in the session.

getUserData

public com.alibaba.fastjson.JSONObject getUserData()

Specified by:

getUserData in interface IPluginDataSourceParams

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.

builder

public static DatenquelleParams.Builder builder()