planetj.magic
Class InsertRowRequest

java.lang.Object
  extended byplanetj.magic.AbstractMagicRequest
      extended byplanetj.magic.MagicRequest
          extended byplanetj.magic.AbstractRowRequest
              extended byplanetj.magic.InsertRowRequest
All Implemented Interfaces:
IFeature, IMagicRequest, java.io.Serializable

public class InsertRowRequest
extends AbstractRowRequest

!!DA (8/7/2003 6:28:32 PM) documenation needed

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
InsertRowRequest(Row row, HttpServletRequest request, HttpServletResponse response)
          Constructor comment.
InsertRowRequest(java.lang.String id, HttpServletRequest req, HttpServletResponse res, java.lang.String rowId)
          Deprecated. by WK on (11/25/2003 1:43:37 PM) should hold reference to row and not the row key also no need for the id
 
Method Summary
 java.lang.String getDataEngineMode()
          By default, InsertRowRequests should be in insert mode.
 java.lang.String getDefaultUserMessage()
          Return the default user message for delete operations.
 boolean isRepeatable()
          By default RowRequests are not repeatable.
 void postInsert(Row row, int numInserted, HttpServletRequest request, HttpServletResponse response)
          Method called after insert is attempted.
 Row prepareInsertRow(Row row, HttpServletRequest request, HttpServletResponse res, DataEngineServlet ser)
          Deprecated. by WK on (8/9/2003 8:16:22 PM) because the HttpServletResponse and DataEngineServlet should never be needed. Made final to ensure that no subclasses override this method thinking their logic will get run. prepareRow is the method called before processing a Row. This method will no longer be available in WOW 7.0.
 Row processRow(Row row, ExecutingContext ec, HttpServletRequest request, HttpServletResponse response)
          Inserts the given Row into the database.
 
Methods inherited from class planetj.magic.AbstractRowRequest
execute, extractDataIntoRow, getDataEngineRowMode, getDefaultEndNavigationGroup, getExecutingContext, getFeatureLevel, getRow, getRowId, postRowProcess, prepareRow, setUserMessage
 
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, 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, isReturnToRequester, 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, isReturnToRequester, isSaveResults, isStartNewNavigationGroup, postExecute, preExecute, setBaseField, setBaseRow, setBaseRowCollection, setEndNavigationGroup, setNextURI, setOverridePrimaryNavigation, setRepeatable, setRowEventListener, setStartNewNavigationGroup
 
Methods inherited from interface planetj.dataengine.IFeature
appendUnsupportedHTMLMessage, isApplicable
 

Constructor Detail

InsertRowRequest

public InsertRowRequest(java.lang.String id,
                        HttpServletRequest req,
                        HttpServletResponse res,
                        java.lang.String rowId)
Deprecated. by WK on (11/25/2003 1:43:37 PM) should hold reference to row and not the row key also no need for the id

Constructor comment


InsertRowRequest

public InsertRowRequest(Row row,
                        HttpServletRequest request,
                        HttpServletResponse response)
Constructor comment.

Method Detail

getDataEngineMode

public java.lang.String getDataEngineMode()
By default, InsertRowRequests should be in insert mode.

Specified by:
getDataEngineMode in class AbstractRowRequest
Returns:
insert mode

getDefaultUserMessage

public java.lang.String getDefaultUserMessage()
Return the default user message for delete operations.

Specified by:
getDefaultUserMessage in class AbstractRowRequest
Returns:
String

postInsert

public void postInsert(Row row,
                       int numInserted,
                       HttpServletRequest request,
                       HttpServletResponse response)
                throws CMException
Method called after insert is attempted. Subclasses may override this method to provide additional functionality after the Row is inserted.

Parameters:
row - Row inserted into the database
numInserted - number of Rows inserted into the database
request - request from client
Throws:
CMException

prepareInsertRow

public final Row prepareInsertRow(Row row,
                                  HttpServletRequest request,
                                  HttpServletResponse res,
                                  DataEngineServlet ser)
                           throws CMException
Deprecated. by WK on (8/9/2003 8:16:22 PM) because the HttpServletResponse and DataEngineServlet should never be needed. Made final to ensure that no subclasses override this method thinking their logic will get run. prepareRow is the method called before processing a Row. This method will no longer be available in WOW 7.0.

Subclasses may override this method to alter the row being used before it is inserted into the database. This method may return a new Row all completly.

Parameters:
row - original Row to be inserted
request - request from client
Throws:
CMException

processRow

public Row processRow(Row row,
                      ExecutingContext ec,
                      HttpServletRequest request,
                      HttpServletResponse response)
               throws CMException
Inserts the given Row into the database.

Specified by:
processRow in class AbstractRowRequest
Parameters:
row - Row to be processed in some manner
ec - current context in which Row should be process during execution
request - request from client
response - response to client
Returns:
processed Row
Throws:
CMException

isRepeatable

public boolean isRepeatable()
Description copied from class: AbstractRowRequest
By default RowRequests are not repeatable. Subclasses may override if they wish to.

Specified by:
isRepeatable in interface IMagicRequest
Overrides:
isRepeatable in class AbstractRowRequest
Returns:
false: boolean true by default