Package com.aquima.web.ui

Class PageWard

java.lang.Object

com.aquima.web.ui.PageWard

All Implemented Interfaces:

com.blueriq.component.api.ui.IPageWard, Serializable

public final class PageWard
extends Object
implements com.blueriq.component.api.ui.IPageWard

A ward is a boundary which signals when one crosses it. This class generates a key on which one can detect if one crossed a certain boundary. Used in conjunction with 'back', 'forward' and F5 detection of the browser. Stored on the session

Since:

5.0

Author:

F. van der Meer

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static PageWard	acquire(jakarta.servlet.http.HttpSession session, com.aquima.interactions.foundation.ApplicationID applicationId, String sessionId)
static PageWard	acquire(org.springframework.web.context.request.WebRequest request, com.aquima.interactions.foundation.ApplicationID applicationId, String sessionId)	This method acquires the pageward for servlets and portlets.
void	generateNewWard()
String	getKey()
String	getWard()
boolean	isExpectedSubmit(org.springframework.web.context.request.WebRequest request, String idPrefix)

Methods inherited from class java.lang.Object

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

Method Details

acquire

public static PageWard acquire(jakarta.servlet.http.HttpSession session,
 com.aquima.interactions.foundation.ApplicationID applicationId,
 String sessionId)

acquire

public static PageWard acquire(org.springframework.web.context.request.WebRequest request,
 com.aquima.interactions.foundation.ApplicationID applicationId,
 String sessionId)

This method acquires the pageward for servlets and portlets.

Parameters:

request - the webrequest (ServletWebRequest or PortletWebRequest)

applicationId - the application id

sessionId - the current session id

Returns:

the pageward

isExpectedSubmit

public boolean isExpectedSubmit(org.springframework.web.context.request.WebRequest request,
 String idPrefix)

Specified by:

isExpectedSubmit in interface com.blueriq.component.api.ui.IPageWard

generateNewWard

public void generateNewWard()

Specified by:

generateNewWard in interface com.blueriq.component.api.ui.IPageWard

getKey

public String getKey()

Specified by:

getKey in interface com.blueriq.component.api.ui.IPageWard

getWard

public String getWard()

Specified by:

getWard in interface com.blueriq.component.api.ui.IPageWard