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 Description PluginFormPreRenderRetVal(SerializableJSONObject metaDataJSON, boolean continueProcessing)
PluginFormPreRenderRetVal(SerializableJSONObject metaDataJSON, Map<String,List<String[]>> formValuesMap, boolean continueProcessing)
PluginFormPreRenderRetVal(Map<String,List<String[]>> formValuesMap, boolean continueProcessing)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
getContinueProcessing()
Map<String,List<String[]>>
getFormValues()
For each key in this map, the values for that key are written to the corresponding form field for that key (its name).Map<Serializable,Serializable>
getFrqSessionAttributeMap()
A map of key-value pairs with FRQ session attributes that are written to theFRQSession
.SerializableJSONObject
getMetaDataJSON()
The global JavaScript objectXFC_METADATA.pluginResults["pluginName"]
contains the data of all form pre render plugins as returned by this method.Map<String,Serializable>
getSessionAttributes()
A map of key-value pairs with session attributes that are written to theHttpSession
.void
setFrqSessionAttributes(Map<Serializable,Serializable> frqSessionAttributes)
void
setSessionAttributes(Map<String,Serializable> sessionAttributes)
-
-
-
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
The global JavaScript objectXFC_METADATA.pluginResults["pluginName"]
contains the data of all form pre render plugins as returned by this method.- Specified by:
getMetaDataJSON
in interfaceIPluginFormPreRenderRetVal
- Returns:
- Data to be made available in the global JavaScript object
XFC_METADATA
.
-
getContinueProcessing
public boolean getContinueProcessing()
- Specified by:
getContinueProcessing
in interfaceIPluginFormPreRenderRetVal
- Returns:
true
to continue as usual, orfalse
to prevent the form from being sent to the user. In the latter case, the user receives a general error page that the form could not be found.
-
getFormValues
public Map<String,List<String[]>> getFormValues()
Description copied from interface:IPluginFormPreRenderRetVal
For each key in this map, the values for that key are written to the corresponding form field for that key (its name). When a form field already contains a value, it is overwritten.Also, please note that is is possible to pre-fill form fields with values from URL parameters. The values in this map take precedence over values from URL parameters. also replace values from URL parameters!
- Specified by:
getFormValues
in interfaceIPluginFormPreRenderRetVal
- Returns:
Map
with the form field values to be set.
-
getSessionAttributes
public Map<String,Serializable> getSessionAttributes()
Description copied from interface:IPluginFormPreRenderRetVal
A map of key-value pairs with session attributes that are written to theHttpSession
. When the session already contains a value for a parameter, it is overwritten.- Specified by:
getSessionAttributes
in interfaceIPluginFormPreRenderRetVal
- Returns:
- A
Map
with session attributes to set on theHttpSession
.
-
setSessionAttributes
public void setSessionAttributes(Map<String,Serializable> sessionAttributes)
-
getFrqSessionAttributeMap
public Map<Serializable,Serializable> getFrqSessionAttributeMap()
Description copied from interface:IPluginFormPreRenderRetVal
A map of key-value pairs with FRQ session attributes that are written to theFRQSession
. When the session already contains a value for a parameter, it is overwritten.- Specified by:
getFrqSessionAttributeMap
in interfaceIPluginFormPreRenderRetVal
- Returns:
- A
Map
with FRQ session attributes to set on theFRQSession
.
-
setFrqSessionAttributes
public void setFrqSessionAttributes(Map<Serializable,Serializable> frqSessionAttributes)
-
-