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

Interface IPluginFormPreRenderParams

All Superinterfaces:

IFormLifecycleExecuteParams, IPluginParameters, Serializable

All Known Implementing Classes:

PluginFormPreRenderParams

public interface IPluginFormPreRenderParams
extends IFormLifecycleExecuteParams, IPluginParameters, Serializable

Interface that encapsulates the parameters for a form pre-render plugin.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IFormRequestContext	getFormRequestContext()
com.alibaba.fastjson.JSONObject	getLdapUserData()
com.alibaba.fastjson.JSONObject	getUserData()

Methods inherited from interface de.xima.fc.interfaces.plugin.param.form.IFormLifecycleExecuteParams

getFrqSessionAttributeMap, getSessionAttributeMap

Method Detail

getFormRequestContext

IFormRequestContext getFormRequestContext()

Specified by:

getFormRequestContext in interface IFormLifecycleExecuteParams

Returns:

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

getLdapUserData

com.alibaba.fastjson.JSONObject getLdapUserData()

Specified by:

getLdapUserData in interface IFormLifecycleExecuteParams

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

getUserData

com.alibaba.fastjson.JSONObject getUserData()

Specified by:

getUserData in interface IFormLifecycleExecuteParams

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