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

Class PluginFormPreRespondParams

java.lang.Object

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

All Implemented Interfaces:

IPluginParameters, IPluginFormPreRespondParams, Serializable

public class PluginFormPreRespondParams
extends Object
implements IPluginFormPreRespondParams

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PluginFormPreRespondParams(IFormRequestContext context, Vorgang vorgang, IWorkflowResponse response)

Method Summary

Modifier and Type	Method and Description
IFormRequestContext	getFormRequestContext()
com.alibaba.fastjson.JSONObject	getLdapUserData() Deprecated.
com.alibaba.fastjson.JSONObject	getUserData()
Vorgang	getVorgang()
IWorkflowResponse	getWorkflowResponse() A pre-respond plugin is executed after the workflow was run.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginFormPreRespondParams

public PluginFormPreRespondParams(IFormRequestContext context,
                                  Vorgang vorgang,
                                  IWorkflowResponse response)

Method Detail

getFormRequestContext

public IFormRequestContext getFormRequestContext()

Specified by:

getFormRequestContext in interface IPluginFormPreRespondParams

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 IPluginFormPreRespondParams

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.

getWorkflowResponse

public IWorkflowResponse getWorkflowResponse()

Description copied from interface: IPluginFormPreRespondParams

A pre-respond plugin is executed after the workflow was run. This method returns the result of that workflow processing.

Specified by:

getWorkflowResponse in interface IPluginFormPreRespondParams

Returns:

The result from the workflow execution.

getUserData

public com.alibaba.fastjson.JSONObject getUserData()

Specified by:

getUserData in interface IPluginFormPreRespondParams

getLdapUserData

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

Deprecated.

Specified by:

getLdapUserData in interface IPluginFormPreRespondParams

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