planetj.magic
Class RetrieveLibrariesRequest

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

All Implemented Interfaces:

Cloneable, IFeature, IHTMLRenderer, IMagicRequest, IRenderer, Serializable

public class RetrieveLibrariesRequest

extends SystemRequest

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

RetrieveLibrariesRequest(String pId, javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse)

RetrieveLibrariesRequest(String pId, javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, String pSystemSessionId, String pLibrariesSessionId)
RetrieveLibrariesRequest constructor comment.

Method Summary

IMagicRequest

execute(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, DataEngineServlet pServlet) Creates a task to retrieve all the libraries for the system alias specified in the constructor.

Methods inherited from class planetj.magic.SystemRequest

getSystem, getSystemSessionId

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, 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

RetrieveLibrariesRequest

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

RetrieveLibrariesRequest

public RetrieveLibrariesRequest(String pId,
                                javax.servlet.http.HttpServletRequest pRequest,
                                javax.servlet.http.HttpServletResponse pResponse,
                                String pSystemSessionId,
                                String pLibrariesSessionId)

RetrieveLibrariesRequest constructor comment.

Parameters:

pLibrariesSessionId - id used to store the libraries in the session once they are retrieved.

Method Detail

execute

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

Creates a task to retrieve all the libraries for the system alias specified in the constructor. When the task finishes, the libraries are then stored in the session using the libraries sesssion id specified in the constructor.

Specified by:

execute in interface IMagicRequest

Specified by:

execute in class AbstractMagicRequest

Parameters:

pRequest - request

pResponse - response

CMException