Package de.xima.fc.plugin.models.params.form

Class PluginFormPreProcessParams

java.lang.Object

de.xima.fc.plugin.models.params.form.PluginFormPreProcessParams

All Implemented Interfaces:

IPluginParameters, IFormLifecycleExecuteParams, IPluginFormPreProcessParams, Serializable

public class PluginFormPreProcessParams
extends Object
implements IPluginFormPreProcessParams

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PluginFormPreProcessParams(IFormRequestContext ctx, Vorgang vorgang)

Method Summary

Modifier and Type	Method	Description
IFormRequestContext	getFormRequestContext()
Map<Serializable,Serializable>	getFrqSessionAttributeMap()	Gets the values stored in the current FRQSession.
com.alibaba.fastjson.JSONObject	getLdapUserData()	Deprecated.
Map<String,Serializable>	getSessionAttributeMap()	Gets the values from the current HttpSession.
com.alibaba.fastjson.JSONObject	getUserData()
Vorgang	getVorgang()

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginFormPreProcessParams

public PluginFormPreProcessParams(IFormRequestContext ctx,
                                  Vorgang vorgang)

Method Detail

getFormRequestContext

public IFormRequestContext getFormRequestContext()

Specified by:

getFormRequestContext in interface IFormLifecycleExecuteParams

Specified by:

getFormRequestContext in interface IPluginFormPreProcessParams

Returns:

The current form request context that may be used to access the submitted form data.

getVorgang

public Vorgang getVorgang()

Specified by:

getVorgang in interface IPluginFormPreProcessParams

Returns:

The current Vorgang. It is newly created if the form was just submitted for the first time. When the form is resubmitted, this is the existing Vorgang.

getUserData

public com.alibaba.fastjson.JSONObject getUserData()

Specified by:

getUserData in interface IFormLifecycleExecuteParams

Specified by:

getUserData in interface IPluginFormPreProcessParams

Returns:

A JSONObject with the current data for the authenticated user. When the current form does not require authorization, this may return an empty JSONObject

getLdapUserData

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

Deprecated.

Specified by:

getLdapUserData in interface IFormLifecycleExecuteParams

Specified by:

getLdapUserData in interface IPluginFormPreProcessParams

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 an empty JSONObject

getFrqSessionAttributeMap

public Map<Serializable,Serializable> getFrqSessionAttributeMap()

Description copied from interface: IFormLifecycleExecuteParams

Gets the values stored in the current FRQSession. The servlet plugin may be executed on a different server that does not have direct access to the HTTP request: Please note that changes to this map are NOT reflected or saved in the FRQSession. To modify the FRQ session attributes, use the IPluginFormPrePersistRetVal.getFrqSessionAttributeMap() return value.

Specified by:

getFrqSessionAttributeMap in interface IFormLifecycleExecuteParams

Returns:

Attributes from the form request session of the current request. If no such session exists, this is an empty map.

getSessionAttributeMap

public Map<String,Serializable> getSessionAttributeMap()

Description copied from interface: IFormLifecycleExecuteParams

Gets the values from the current HttpSession. The servlet plugin may be executed on a different server that does not have direct access to the HTTP request: Please note that changes to this map are NOT reflected or saved in the HttpSession. To modify the session attributes, use the IPluginFormPreRenderRetVal.getSessionAttributes() return value.

Specified by:

getSessionAttributeMap in interface IFormLifecycleExecuteParams

Returns:

A map Map with all attributes of the current HttpSession.