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

Interface IPluginFormPreProcessParams

All Superinterfaces:

IFormLifecycleExecuteParams, IPluginParameters, Serializable

All Known Implementing Classes:

PluginFormPreProcessParams

public interface IPluginFormPreProcessParams
extends IFormLifecycleExecuteParams, IPluginParameters, Serializable

Interface for the parameters of form pre-process plugins.

Author:

XIMA MEDIA GmbH

Method Summary

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

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.

getVorgang

Vorgang getVorgang()

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.

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