planetj.magic
Class UpdateRowRequest

java.lang.Object
  planetj.magic.AbstractMagicRequest
      planetj.magic.MagicRequest
          planetj.magic.AbstractRowRequest
              planetj.magic.UpdateRowRequest

All Implemented Interfaces:

IFeature, IMagicRequest, java.io.Serializable

public class UpdateRowRequest

extends AbstractRowRequest

This class gets a Row out of the request extracts values into it and updates the Row.

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

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

UpdateRowRequest(java.lang.String id, HttpServletRequest request, HttpServletResponse response, 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

Row	extractDataIntoRow(HttpServletRequest request) Gets the Row out of the request and extracts data from the request into it.
java.lang.String	getDataEngineMode() By default, UpdateRowRequests should be in edit mode.
java.lang.String	getDefaultUserMessage() Return the default user message for update operations.
boolean	isRepeatable() By default RowRequests are not repeatable.
void	postUpdate(Row row, int numUpdated, HttpServletRequest request, HttpServletResponse response) Method called after update is attempted.
Row	prepareUpdateRow(Row row, HttpServletRequest pReq, HttpServletResponse pRes, DataEngineServlet servlet) 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) Updated the given Row into the database.

Methods inherited from class planetj.magic.AbstractRowRequest

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

UpdateRowRequest

public UpdateRowRequest(java.lang.String id,
                        HttpServletRequest request,
                        HttpServletResponse response,
                        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

UpdateRequest constructor comment.

UpdateRowRequest

public UpdateRowRequest(Row row,
                        HttpServletRequest request,
                        HttpServletResponse response)

Constructor comment.

Method Detail

extractDataIntoRow

public Row extractDataIntoRow(HttpServletRequest request)
                       throws CMException

Description copied from class: AbstractRowRequest

Gets the Row out of the request and extracts data from the request into it.

Overrides:

extractDataIntoRow in class AbstractRowRequest

Parameters:

request - request from the client

Returns:

Row extracted from the request

Throws:

CMException

getDataEngineMode

public java.lang.String getDataEngineMode()

By default, UpdateRowRequests should be in edit mode.

Specified by:

getDataEngineMode in class AbstractRowRequest

Returns:

edit mode

getDefaultUserMessage

public java.lang.String getDefaultUserMessage()

Return the default user message for update operations.

Specified by:

getDefaultUserMessage in class AbstractRowRequest

Returns:

String

postUpdate

public void postUpdate(Row row,
                       int numUpdated,
                       HttpServletRequest request,
                       HttpServletResponse response)
                throws CMException

Method called after update is attempted. Subclasses may override this method to provide additional functionality after the Row is updated.

Parameters:

row - Row inserted into the database

numUpdated - number of Rows updated into the database

request - request from client

Throws:

CMException

prepareUpdateRow

public final Row prepareUpdateRow(Row row,
                                  HttpServletRequest pReq,
                                  HttpServletResponse pRes,
                                  DataEngineServlet servlet)
                           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.

Override this method to alter the row before it is updated in the db. Creation date: (3/27/2003 4:39:51 PM)

Throws:

CMException

processRow

public Row processRow(Row row,
                      ExecutingContext ec,
                      HttpServletRequest request,
                      HttpServletResponse response)
               throws CMException

Updated 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