planetj.magic
Class NavigateToRequest

java.lang.Object
  |
  +--planetj.html.AbstractHTMLRenderer
        |
        +--planetj.magic.AbstractMagicRequest
              |
              +--planetj.magic.MagicRequest
                    |
                    +--planetj.magic.NavigateToRequest

All Implemented Interfaces:

Cloneable, IFeature, IHTMLRenderer, IMagicRequest, IRenderer, Serializable

Direct Known Subclasses:

SignOffRequest

public class NavigateToRequest

extends MagicRequest

implements Cloneable

Request a magic navigate to request which will go to the specified uri.

Author:

PlanetJ Corporation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.dataengine.IFeature

IFeature.OperationCountFeature

Field Summary

Fields inherited from class planetj.html.AbstractHTMLRenderer

className

Fields inherited from interface planetj.magic.IMagicRequest

IS_COMPLETE, MAGIC_REQUEST, MAGIC_REQUEST_PARAM1, MAGIC_REQUEST_RC, SAME_URI, TYPE, TYPE_PAGE, TYPE_SESSION, TYPE_STATIC, USER_REQUEST_ATTRIBUTES_STORED

Fields inherited from interface planetj.html.IHTMLRenderer

HTML

Fields inherited from interface planetj.dataengine.IFeature

DEFAULT_MESSAGE_FEATURE, FEATURE_DELETE, FEATURE_INSERT, FEATURE_LEVEL_ENTERPRISE, FEATURE_LEVEL_ENTRY, FEATURE_LEVEL_PROFESSIONAL, FEATURE_LEVEL_STANDARD, FEATURE_UPDATE, MESSAGE_END, MESSAGE_START

Constructor Summary

NavigateToRequest(String pId, javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, String pURI)
Deprecated. replaced with (String, String, HttpServletRequest, HttpServletResponse)

NavigateToRequest(String pId, javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, String section, String uri)
Deprecated. replaced with (String, String, String, HttpServletRequest, HttpServletResponse)

NavigateToRequest(String id, String uri, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
NavigateToRequest constructor.

NavigateToRequest(String id, String section, String uri, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
NavigateToRequest constructor.

Method Summary

IMagicRequest	execute(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, DataEngineServlet pServlet) This method simple sets the magic request's requester to that of the specified uri.
void	setNextURI(String uri) Set the URI of the next page to call.

Methods inherited from class planetj.magic.MagicRequest

getType, store

Methods inherited from class planetj.magic.AbstractMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, appendUnsupportedHTMLMessage, clone, clone, equals, executeAll, getAnchorName, getBaseField, getBaseRow, getBaseRowCollection, getCurrentURI, getDefaultEndNavigationGroup, getFailMessage, getFeatureLevel, getFirstRequest, getId, getKey, getLastRequest, getMagicServletURI, getMagicURI, getNextURI, getRequestAttribute, getRequestParameter, getRequestParameterValues, getSessionAttribute, getSharedSessionAttribute, getSuccessMessage, hasLinkedRequestsAfter, hasLinkedRequestsBefore, isApplicable, isCompleted, isEndNavigationGroup, isPopup, isReturnToRequester, isSaveResults, isStartNewNavigationGroup, preexecute, removeRequestAttribute, removeSessionAttribute, removeSharedSessionAttribute, setAnchorName, setBaseField, setBaseRow, setBaseRowCollection, setCompleted, setEndNavigationGroup, setFailMessage, setId, setNextURI, setNextURIs, setPopup, setRequestGroupAttribute, setRequestPageAttribute, setRequestPersistentAttribute, setRequestTransientAttribute, setReturnToRequester, setRowEventListener, setSessionAttribute, setSessionSharedAttribute, setStartNewNavigationGroup, setSuccessMessage

Methods inherited from class planetj.html.AbstractHTMLRenderer

append, generate, getDisplayType

Methods inherited from class java.lang.Object

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

Methods inherited from interface planetj.magic.IMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, executeAll, getBaseField, getBaseRow, getCurrentURI, getFirstRequest, getId, getKey, getLastRequest, getMagicURI, getNextURI, isCompleted, isEndNavigationGroup, isReturnToRequester, isSaveResults, isStartNewNavigationGroup, setBaseField, setBaseRow, setRowEventListener

Methods inherited from interface planetj.html.IHTMLRenderer

append, generate

Methods inherited from interface planetj.dataengine.display.IRenderer

getDisplayType

Methods inherited from interface planetj.dataengine.IFeature

appendUnsupportedHTMLMessage, getFeatureLevel, isApplicable

Constructor Detail

NavigateToRequest

public NavigateToRequest(String id,
                         String section,
                         String uri,
                         javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)

NavigateToRequest constructor.

NavigateToRequest

public NavigateToRequest(String id,
                         String uri,
                         javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)

NavigateToRequest constructor.

NavigateToRequest

public NavigateToRequest(String pId,
                         javax.servlet.http.HttpServletRequest pRequest,
                         javax.servlet.http.HttpServletResponse pResponse,
                         String pURI)

Deprecated. replaced with (String, String, HttpServletRequest, HttpServletResponse)

NavigateToRequest constructor.

Parameters:

pRequest - request

pResponse - response

pURI - uri to navigate to when requested

NavigateToRequest

public NavigateToRequest(String pId,
                         javax.servlet.http.HttpServletRequest pRequest,
                         javax.servlet.http.HttpServletResponse pResponse,
                         String section,
                         String uri)

Deprecated. replaced with (String, String, String, HttpServletRequest, HttpServletResponse)

NavigateToRequest constructor.

Parameters:

pRequest - request

pResponse - response

Method Detail

execute

public IMagicRequest execute(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse res,
                             DataEngineServlet pServlet)
                      throws CMException

This method simple sets the magic request's requester to that of the specified uri. This allows the specified uri to load.

Specified by:

execute in interface IMagicRequest

Specified by:

execute in class AbstractMagicRequest

Returns:

this

CMException

setNextURI

public void setNextURI(String uri)

Set the URI of the next page to call. This method counters any template pages previously set. When the magic request finishes executing, the uri parameter will be called. If the uri should be included in a template, then setNextURI(String, String) should be called.

Overrides:

setNextURI in class AbstractMagicRequest