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, 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()
com.alibaba.fastjson.JSONObject	getLdapUserData()	Deprecated.
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 IPluginFormPreProcessParams

Returns:

IExtendedFormRequestContext 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 IPluginFormPreProcessParams

getLdapUserData

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

Deprecated.

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