planetj.magic
Class SignOnRequest

java.lang.Object
  |
  +--planetj.html.AbstractHTMLRenderer
        |
        +--planetj.magic.AbstractMagicRequest
              |
              +--planetj.magic.MagicRequest
                    |
                    +--planetj.magic.SignOnRequest
All Implemented Interfaces:
IFeature, IHTMLRenderer, IMagicRequest, IRenderer, Serializable
Direct Known Subclasses:
SignOnBaseRequest

public abstract class SignOnRequest
extends MagicRequest

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
SignOnRequest(String pId, javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, String pJDBCDriver)
          QueryRequest constructor comment.
 
Method Summary
 StringBuffer appendUnsupportedHTMLMessage(StringBuffer html)
          Appends the default unsupported message
 IMagicRequest execute(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, DataEngineServlet pServlet)
          execute method comment.
 String getDriver(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse)
           
 int getFeatureLevel()
          Gets the minimum feature level requried to execute this operation
abstract  String getPassword(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse)
           
abstract  DBSystem getSystem(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse)
           
abstract  String getUserId(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse)
           
 boolean isSaveResults()
          Deprecated. - from code prior to navigation and layouts - wasn't referenced or used any where !!N WK (4/22/2003 8:27:47 AM)
 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, clone, clone, equals, executeAll, getAnchorName, getBaseField, getBaseRow, getBaseRowCollection, getCurrentURI, getDefaultEndNavigationGroup, getFailMessage, getFirstRequest, getId, getKey, getLastRequest, getMagicServletURI, getMagicURI, getNextURI, getRequestAttribute, getRequestParameter, getRequestParameterValues, getSessionAttribute, getSharedSessionAttribute, getSuccessMessage, hasLinkedRequestsAfter, hasLinkedRequestsBefore, isApplicable, isCompleted, isEndNavigationGroup, isPopup, isReturnToRequester, 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, 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
isApplicable
 

Constructor Detail

SignOnRequest

public SignOnRequest(String pId,
                     javax.servlet.http.HttpServletRequest pRequest,
                     javax.servlet.http.HttpServletResponse pResponse,
                     String pJDBCDriver)
QueryRequest constructor comment.

Method Detail

execute

public IMagicRequest execute(javax.servlet.http.HttpServletRequest pRequest,
                             javax.servlet.http.HttpServletResponse pResponse,
                             DataEngineServlet pServlet)
                      throws CMException
execute method comment.

Specified by:
execute in interface IMagicRequest
Specified by:
execute in class AbstractMagicRequest
CMException

getDriver

public String getDriver(javax.servlet.http.HttpServletRequest pRequest,
                        javax.servlet.http.HttpServletResponse pResponse)

getPassword

public abstract String getPassword(javax.servlet.http.HttpServletRequest pRequest,
                                   javax.servlet.http.HttpServletResponse pResponse)

getSystem

public abstract DBSystem getSystem(javax.servlet.http.HttpServletRequest pRequest,
                                   javax.servlet.http.HttpServletResponse pResponse)
                            throws DataEngineException
DataEngineException

getUserId

public abstract String getUserId(javax.servlet.http.HttpServletRequest pRequest,
                                 javax.servlet.http.HttpServletResponse pResponse)

isSaveResults

public boolean isSaveResults()
Deprecated. - from code prior to navigation and layouts - wasn't referenced or used any where !!N WK (4/22/2003 8:27:47 AM)

Tests if the results of executing this magic request should be saved. This allows the user to go back to this result after viewing another page. If this method returns false, and the user goes back from viewing a later page, the results of this request will be "skipped" and the user will see results from a page "before" this one.

Specified by:
isSaveResults in interface IMagicRequest
Overrides:
isSaveResults in class AbstractMagicRequest

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

appendUnsupportedHTMLMessage

public StringBuffer appendUnsupportedHTMLMessage(StringBuffer html)
Appends the default unsupported message

Specified by:
appendUnsupportedHTMLMessage in interface IFeature
Overrides:
appendUnsupportedHTMLMessage in class AbstractMagicRequest

getFeatureLevel

public int getFeatureLevel()
Gets the minimum feature level requried to execute this operation

Specified by:
getFeatureLevel in interface IFeature
Overrides:
getFeatureLevel in class AbstractMagicRequest