de.xima.fc.interfaces.plugin.retval.form

Interface IPluginFormPreRenderRetVal

All Superinterfaces:

IPluginReturnValue, Serializable

All Known Implementing Classes:

PluginFormPreRenderRetVal

public interface IPluginFormPreRenderRetVal
extends IPluginReturnValue, Serializable

Interface for the return value for Form PreRender plugins

Author:

xima media GmbH, Dresden - Michael Kohlsche - 24.08.2015

Method Summary

Modifier and Type	Method and Description
boolean	getContinueProcessing() Getter if the processing should be continued after this plugin.
Map<String,List<String[]>>	getFormValues() Getter for the values map used to pre-fill fields when rendering the form.
SerializableJSONObject	getMetaDataJSON() Getter for the serializable JSON object which should be written to the form variable XFC_METADATA, under the plugin name.
Map<String,Serializable>	getSessionAttributes() Getter for a map to set session attributes.

Method Detail

getMetaDataJSON

SerializableJSONObject getMetaDataJSON()

Getter for the serializable JSON object which should be written to the form variable XFC_METADATA, under the plugin name.

Returns:

SerializableJSONObject for the XFC_METADATA variable

getFormValues

Map<String,List<String[]>> getFormValues()

Getter for the values map used to pre-fill fields when rendering the form. These may overwrite existing values and also replace values from URL parameters!

Returns:

Map with the form field values

getContinueProcessing

boolean getContinueProcessing()

Getter if the processing should be continued after this plugin.

Returns:

Boolean whether the processing should be continued

getSessionAttributes

Map<String,Serializable> getSessionAttributes()

Getter for a map to set session attributes. These are put to the HttpSession and possibly overwrite existing values!

Returns:

Map with session attributes to set

Since:

6.0