Interface IPluginServletActionRetVal
- 
- All Superinterfaces:
 IPluginReturnValue,Serializable
- All Known Implementing Classes:
 PluginServletActionRetVal
public interface IPluginServletActionRetVal extends IPluginReturnValue, Serializable
Interface for the return value of a servlet action plugin.- Author:
 - XIMA MEDIA GmbH
 
 
- 
- 
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Map<String,Serializable>getFrqSessionAttributeMap()A map of key-value pairs with FRQ session attributes that are written to theFRQSession.default intgetHttpStatusCode()IServletResponsegetResponse()default Map<String,Serializable>getSessionAttributeMap()A map of key-value pairs with session attributes that are written to theHttpSession. 
 - 
 
- 
- 
Method Detail
- 
getResponse
IServletResponse getResponse()
- Returns:
 - The 
IServletResponsethat is to be returned to the client in response to the HTTP request. 
 
- 
getSessionAttributeMap
default Map<String,Serializable> getSessionAttributeMap()
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.- Returns:
 - A 
Mapwith session attributes to set on theHttpSession. - Since:
 - 7.0.13
 
 
- 
getFrqSessionAttributeMap
default Map<String,Serializable> getFrqSessionAttributeMap()
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.- Returns:
 - A 
Mapwith FRQ session attributes to set on theFRQSession. - Since:
 - 7.0.13
 
 
- 
getHttpStatusCode
default int getHttpStatusCode()
- Returns:
 - The HTTP status code that is to be returned to the client in response to the HTTP request.
 
 
 - 
 
 -