de.xima.fc.plugin.interfaces.form

Interface IPluginFormPreRespond

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

public interface IPluginFormPreRespond
extends IFCPlugin

Interface for a form pre-respond plugin. This plugin is executed when the form is submitted, after a FormEingang was created workflow processing was run; and immediately before the HTTP response is about to be sent to the browser. Contrast this with a plugin of type IPluginFormPrePersist, which is run before a FormEingang is created; and to IPluginFormPreProcess, which is run before processing the workflow.

This plugin can be used, for example, to prevent the response from being sent to the user and display an empty page. It can also be used to modify or add HTTP session attributes; or to perform additional logic such as sending the data to a third-party webservice.

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Method Summary

Modifier and Type	Method and Description
IPluginFormPreRespondRetVal	execute(IPluginFormPreRespondParams params) The main method of this plugin.

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, getDescription, getDisplayName, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall

Method Detail

execute

IPluginFormPreRespondRetVal execute(IPluginFormPreRespondParams params)
                             throws FCPluginException

The main method of this plugin. Performs any additional actions before the response is sent to the browser.

When any exception other than FCPluginException is thrown, the response will not be sent to the browser and a general error template is returned to the user who submitted the form.

Parameters:

params - The parameters this plugin may make use of. Contains for example the current Projekt, the current FormEingang, session parameters.

Returns:

Whether the response should be sent to the browser (or just show a generic error page); and which HTTP session parameters should be modified.

Throws:

FCPluginException - May be thrown when this plugin cannot perform is task due to any reason. Please note that throwing this exception will not prevent the response from being sent.