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

Interface IPluginFormPreRespondParams

All Superinterfaces:

IPluginParameters, Serializable

All Known Implementing Classes:

PluginFormPreRespondParams

public interface IPluginFormPreRespondParams
extends IPluginParameters, Serializable

Interface for the parameters of form pre-respond plugins.

Author:

XIMA MEDIA GmbH

Method Summary

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

Method Detail

getFormRequestContext

IFormRequestContext getFormRequestContext()

Returns:

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

getWorkflowResponse

IWorkflowResponse getWorkflowResponse()

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

Returns:

The result from the workflow execution.

getLdapUserData

com.alibaba.fastjson.JSONObject getLdapUserData()

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

Since:

6.2

getUserData

com.alibaba.fastjson.JSONObject getUserData()