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

Class PluginGenericFormProcessingRetVal

java.lang.Object

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

All Implemented Interfaces:

IPluginReturnValue, IPluginFormPrePersistRetVal, IPluginFormPreProcessRetVal, IPluginFormPreRespondRetVal, Serializable

public class PluginGenericFormProcessingRetVal
extends Object
implements IPluginFormPrePersistRetVal, IPluginFormPreProcessRetVal, IPluginFormPreRespondRetVal

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PluginGenericFormProcessingRetVal(boolean continueProcessing)

Method Summary

Modifier and Type	Method	Description
boolean	getContinueProcessing()
Map<Serializable,Serializable>	getFrqSessionAttributeMap()	A map of key-value pairs with FRQ session attributes that are written to the FRQSession.
Map<String,Serializable>	getSessionAttributeMap()	A map of key-value pairs with session attributes that are written to the HttpSession.
Map<String,Serializable>	getSessionAttributes()	Deprecated. use getSessionAttributeMap()
void	setFrqSessionAttributes(Map<Serializable,Serializable> frqSessionAttributes)
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

PluginGenericFormProcessingRetVal

public PluginGenericFormProcessingRetVal(boolean continueProcessing)

Method Detail

getContinueProcessing

public boolean getContinueProcessing()

Specified by:

getContinueProcessing in interface IPluginFormPrePersistRetVal

Specified by:

getContinueProcessing in interface IPluginFormPreProcessRetVal

Specified by:

getContinueProcessing in interface IPluginFormPreRespondRetVal

Returns:

true to continue as usual, false to prevent the form submission and discard the submitted form data.

getSessionAttributes

@Deprecated
public Map<String,Serializable> getSessionAttributes()

Deprecated.

use getSessionAttributeMap()

Description copied from interface: IPluginFormPreRespondRetVal

A map of key-value pairs with session attributes that are written to the HttpSession. When the session already contains a value for a parameter, it is overwritten.

Specified by:

getSessionAttributes in interface IPluginFormPreRespondRetVal

Returns:

A Map with session attributes to set on the HttpSession.

getSessionAttributeMap

public Map<String,Serializable> getSessionAttributeMap()

Description copied from interface: IPluginFormPrePersistRetVal

A map of key-value pairs with session attributes that are written to the HttpSession. When the session already contains a value for a parameter, it is overwritten.

Specified by:

getSessionAttributeMap in interface IPluginFormPrePersistRetVal

Specified by:

getSessionAttributeMap in interface IPluginFormPreProcessRetVal

Specified by:

getSessionAttributeMap in interface IPluginFormPreRespondRetVal

Returns:

A Map with session attributes to set on the HttpSession.

setSessionAttributes

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

getFrqSessionAttributeMap

public Map<Serializable,Serializable> getFrqSessionAttributeMap()

Description copied from interface: IPluginFormPrePersistRetVal

A map of key-value pairs with FRQ session attributes that are written to the FRQSession. When the session already contains a value for a parameter, it is overwritten.

Specified by:

getFrqSessionAttributeMap in interface IPluginFormPrePersistRetVal

Specified by:

getFrqSessionAttributeMap in interface IPluginFormPreProcessRetVal

Specified by:

getFrqSessionAttributeMap in interface IPluginFormPreRespondRetVal

Returns:

A Map with FRQ session attributes to set on the FRQSession.

setFrqSessionAttributes

public void setFrqSessionAttributes(Map<Serializable,Serializable> frqSessionAttributes)