planetj.magic
Class AddRowRequest

java.lang.Object
  extended byplanetj.magic.AbstractMagicRequest
      extended byplanetj.magic.MagicRequest
          extended byplanetj.magic.AddRowRequest
All Implemented Interfaces:
IFeature, IMagicRequest, java.io.Serializable
Direct Known Subclasses:
AddRecordRequest

public class AddRowRequest
extends MagicRequest

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
AddRowRequest(java.lang.String pId, HttpServletRequest pReq, HttpServletResponse pRes)
          AddRowRequest constructor.
AddRowRequest(java.lang.String pId, HttpServletRequest pReq, HttpServletResponse pRes, java.lang.String rowSessionId)
          AddRowRequest constructor.
AddRowRequest(java.lang.String pId, HttpServletRequest pReq, HttpServletResponse pRes, Table table, java.lang.Class rowSubClass, java.lang.String rowSessionId)
          CancelRequest constructor comment.
AddRowRequest(Table table, java.lang.Class rowSubClass, HttpServletRequest request, HttpServletResponse response)
          Creates a new AddRowRequest that will create a new row of the given type and for the given table and put the row into the session to allow editing and inserting of the new row.
 
Method Summary
 void addTable(Table table)
          Adds a table to this MRs tables
 IMagicRequest execute(HttpServletRequest request, HttpServletResponse response, DataEngineServlet pServlet)
          execute method comment.
 PropertyGroupList getProperties()
           
 java.lang.Class getRowClass()
           
 java.lang.String getRowSessionId()
           
 Table getTable()
          Gets one of this MRs tables
 TableCollection getTables()
          Gets this MRs tables
 boolean isStartNewNavigationGroup()
          Tests whether or not this magic request needs to start a new navigation group.
 void setProperties(PropertyGroupList pgl)
           
 void setRowClass(java.lang.Class rowClass)
           
 void setRowSessionId(java.lang.String rowSessionId)
           
 void setTable(Table table)
          Deprecated. Use addTable() or setTables() instead
 void setTables(java.util.List tables)
          Sets the tables for this MR
 
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, getFeatureLevel, 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, isReturnToRequester, isSaveResults, 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, isReturnToRequester, isSaveResults, postExecute, preExecute, setBaseField, setBaseRow, setBaseRowCollection, setEndNavigationGroup, setNextURI, setOverridePrimaryNavigation, setRepeatable, setRowEventListener, setStartNewNavigationGroup
 
Methods inherited from interface planetj.dataengine.IFeature
appendUnsupportedHTMLMessage, getFeatureLevel, isApplicable
 

Constructor Detail

AddRowRequest

public AddRowRequest(java.lang.String pId,
                     HttpServletRequest pReq,
                     HttpServletResponse pRes)
AddRowRequest constructor. Note: before this MagicRequest can be executed, it needs to know the Table and Class of the Row to create.


AddRowRequest

public AddRowRequest(java.lang.String pId,
                     HttpServletRequest pReq,
                     HttpServletResponse pRes,
                     java.lang.String rowSessionId)
AddRowRequest constructor. Note: before this MagicRequest can be executed, it needs to know the Table and Class of the Row to create.


AddRowRequest

public AddRowRequest(java.lang.String pId,
                     HttpServletRequest pReq,
                     HttpServletResponse pRes,
                     Table table,
                     java.lang.Class rowSubClass,
                     java.lang.String rowSessionId)
CancelRequest constructor comment.


AddRowRequest

public AddRowRequest(Table table,
                     java.lang.Class rowSubClass,
                     HttpServletRequest request,
                     HttpServletResponse response)
Creates a new AddRowRequest that will create a new row of the given type and for the given table and put the row into the session to allow editing and inserting of the new row.

Method Detail

addTable

public void addTable(Table table)
Adds a table to this MRs tables


execute

public IMagicRequest execute(HttpServletRequest request,
                             HttpServletResponse response,
                             DataEngineServlet pServlet)
                      throws CMException
execute method comment.

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

getProperties

public PropertyGroupList getProperties()

getRowClass

public java.lang.Class getRowClass()

getRowSessionId

public java.lang.String getRowSessionId()

getTable

public Table getTable()
Gets one of this MRs tables


getTables

public TableCollection getTables()
Gets this MRs tables


isStartNewNavigationGroup

public boolean isStartNewNavigationGroup()
Description copied from interface: IMagicRequest
Tests whether or not this magic request needs to start a new navigation group.

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

setProperties

public void setProperties(PropertyGroupList pgl)

setRowClass

public void setRowClass(java.lang.Class rowClass)

setRowSessionId

public void setRowSessionId(java.lang.String rowSessionId)

setTable

public void setTable(Table table)
Deprecated. Use addTable() or setTables() instead


setTables

public void setTables(java.util.List tables)
Sets the tables for this MR