planetj.magic
Class CSVRequest

java.lang.Object
  planetj.magic.AbstractMagicRequest
      planetj.magic.MagicRequest
          planetj.magic.CSVRequest

All Implemented Interfaces:

java.lang.Cloneable, IFeature, IMagicRequest, java.io.Serializable

public class CSVRequest

extends MagicRequest

implements java.lang.Cloneable

Request a magic Excel request which will generate a CSV File and bring it up in an Excel plugin within the browser. Creation date: (12/6/2001 8:37:51 PM)

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.dataengine.IFeature

IFeature.OperationCountFeature

Field Summary

Fields inherited from interface planetj.magic.IMagicRequest

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

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

CSVRequest(HttpServletRequest pRequest, HttpServletResponse pResponse, java.lang.String pTableId)
CSVRequest constructor.

CSVRequest(java.lang.String pId, HttpServletRequest pRequest, HttpServletResponse pResponse, java.lang.String pTableId)
Deprecated. id no longer needed

Method Summary

IMagicRequest	execute(HttpServletRequest req, HttpServletResponse res, DataEngineServlet pServlet) This method will generate CSV data from a RowCollection specified in the Constructor.
int	getFeatureLevel() Gets the minimum feature level requried to execute this operation
boolean	isReturnToRequester() Returns whether or not the magic request needs to be returned to the requester.

Methods inherited from class planetj.magic.MagicRequest

getCurrentMagicRequest, getPrimaryMagicRequest, getType, store

Methods inherited from class planetj.magic.AbstractMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, appendUnsupportedHTMLMessage, changeMode, clone, clone, equals, executeAll, getAnchorName, getBaseField, getBaseRow, getBaseRowCollection, getCurrentURI, getDefaultEndNavigationGroup, getDefaultPageType, getFailMessage, getFirstRequest, getId, getKey, getLastRequest, getMagicRequestParameter, getMagicServletURI, getMagicURI, getNextURI, getPleaseWaitJSP, getPleaseWaitOperation, getRequestAttribute, getRequestParameter, getRequestParameterValues, getSessionAttribute, getSharedSessionAttribute, getSuccessMessage, hasLinkedRequestsAfter, hasLinkedRequestsBefore, isApplicable, isCompleted, isEndNavigationGroup, isLoadParameterValuesFromRequest, isOverridePrimaryNavigation, isPleaseWait, isPopup, isRepeatable, isSaveResults, isStartNewNavigationGroup, postexecute, postExecute, preexecute, preExecute, processPleaseWait, removeRequestAttribute, removeSessionAttribute, removeSharedSessionAttribute, setAnchorName, setBaseField, setBaseRow, setBaseRowCollection, setCompleted, setEndNavigationGroup, setFailMessage, setId, setLoadParameterValuesFromRequest, setNextURI, setNextURI, setNextURI, setNextURIs, setOverridePrimaryNavigation, setPopup, setRepeatable, setRequestGroupAttribute, setRequestPageAttribute, setRequestPersistentAttribute, setRequestTransientAttribute, setReturnToRequester, setRowEventListener, setSessionAttribute, setSessionSharedAttribute, setStartNewNavigationGroup, setSuccessMessage

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, getMagicRequestParameter, getMagicURI, getNextURI, isCompleted, isEndNavigationGroup, isOverridePrimaryNavigation, isRepeatable, isSaveResults, isStartNewNavigationGroup, postExecute, preExecute, setBaseField, setBaseRow, setBaseRowCollection, setEndNavigationGroup, setNextURI, setOverridePrimaryNavigation, setRepeatable, setRowEventListener, setStartNewNavigationGroup

Methods inherited from interface planetj.dataengine.IFeature

appendUnsupportedHTMLMessage, isApplicable

Constructor Detail

CSVRequest

public CSVRequest(HttpServletRequest pRequest,
                  HttpServletResponse pResponse,
                  java.lang.String pTableId)

CSVRequest constructor. None of the params may be null Creation date: (12/10/2001 11:54:29 PM)

CSVRequest

public CSVRequest(java.lang.String pId,
                  HttpServletRequest pRequest,
                  HttpServletResponse pResponse,
                  java.lang.String pTableId)

Deprecated. id no longer needed

CSVRequest constructor. None of the params may be null Creation date: (12/10/2001 11:54:29 PM)

Method Detail

execute

public IMagicRequest execute(HttpServletRequest req,
                             HttpServletResponse res,
                             DataEngineServlet pServlet)
                      throws CMException

This method will generate CSV data from a RowCollection specified in the Constructor. In addition, this method prepares the response to handle the Excel plugin by setting its content type. If this RowCollection hasNextRowCollection, then all the data in the following RowCollections will be generated into XML format.

Creation date: (12/10/2001 11:48:24 PM)

Specified by:

execute in interface IMagicRequest

Specified by:

execute in class AbstractMagicRequest

Throws:

CMException

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

isReturnToRequester

public boolean isReturnToRequester()

Returns whether or not the magic request needs to be returned to the requester. Defaults to true. If any "Magic" requests do not require return to the requester, then this method should be overridden.

Specified by:

isReturnToRequester in interface IMagicRequest

Overrides:

isReturnToRequester in class AbstractMagicRequest

Returns:

boolean