de.xima.fc.plugin.models.retval.form

Class PluginFormPreRenderRetVal

java.lang.Object

de.xima.fc.plugin.models.retval.form.PluginFormPreRenderRetVal

All Implemented Interfaces:

IPluginReturnValue, IPluginFormPreRenderRetVal, Serializable

public class PluginFormPreRenderRetVal
extends Object
implements IPluginFormPreRenderRetVal

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PluginFormPreRenderRetVal(Map<String,List<String[]>> formValuesMap, boolean continueProcessing)
PluginFormPreRenderRetVal(SerializableJSONObject metaDataJSON, boolean continueProcessing)
PluginFormPreRenderRetVal(SerializableJSONObject metaDataJSON, Map<String,List<String[]>> formValuesMap, boolean continueProcessing)

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.
void	setSessionAttributes(Map<String,Serializable> sessionAttributes)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginFormPreRenderRetVal

public PluginFormPreRenderRetVal(SerializableJSONObject metaDataJSON,
                                 Map<String,List<String[]>> formValuesMap,
                                 boolean continueProcessing)

PluginFormPreRenderRetVal

public PluginFormPreRenderRetVal(Map<String,List<String[]>> formValuesMap,
                                 boolean continueProcessing)

PluginFormPreRenderRetVal

public PluginFormPreRenderRetVal(SerializableJSONObject metaDataJSON,
                                 boolean continueProcessing)

Method Detail

getMetaDataJSON

public SerializableJSONObject getMetaDataJSON()

Description copied from interface: IPluginFormPreRenderRetVal

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

Specified by:

getMetaDataJSON in interface IPluginFormPreRenderRetVal

Returns:

SerializableJSONObject for the XFC_METADATA variable

getContinueProcessing

public boolean getContinueProcessing()

Description copied from interface: IPluginFormPreRenderRetVal

Getter if the processing should be continued after this plugin.

Specified by:

getContinueProcessing in interface IPluginFormPreRenderRetVal

Returns:

Boolean whether the processing should be continued

getFormValues

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

Description copied from interface: IPluginFormPreRenderRetVal

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!

Specified by:

getFormValues in interface IPluginFormPreRenderRetVal

Returns:

Map with the form field values

getSessionAttributes

public Map<String,Serializable> getSessionAttributes()

Description copied from interface: IPluginFormPreRenderRetVal

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

Specified by:

getSessionAttributes in interface IPluginFormPreRenderRetVal

Returns:

Map with session attributes to set

setSessionAttributes

public void setSessionAttributes(Map<String,Serializable> sessionAttributes)