com.dpslink.flash.servlet

Class QuickOrder

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.dpslink.base.servlet.BaseServlet

com.dpslink.flash.servlet.FlashServlet

com.dpslink.flash.servlet.MainServlet

com.dpslink.flash.servlet.QuickOrder

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class QuickOrder
extends MainServlet

Writes and processes the store's quick order page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	QuickOrder.Context Inner class used to store servlet context information.
protected class	QuickOrder.SearchResult Inner class that defines auto complete search result data that is sent to the browser.

Nested classes/interfaces inherited from class com.dpslink.flash.servlet.FlashServlet

FlashServlet.Stack

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.flash.servlet.MainServlet

DISPLAY_MODE, SN_ADMINMODE, SN_CATEGORIES, SN_CATEGORIES_LISTONLY, SN_CATEGORIES_PATH, SN_CATEGORY, SN_CONTINUE_PAGEURL, SN_PRODUCTS, SN_PRODUCTS_INSTOCK, SN_PRODUCTS_NOSTOCK, SN_PRODUCTS_PAFILTERS, SN_PRODUCTS_PAGEHIST, SN_PRODUCTS_PAGENUM, SN_PRODUCTS_PAGEURL, SOURCE_CATALOG, SOURCE_FAVORITES, SOURCE_SEARCH, SOURCE_SHOPCART, SOURCE_SPECIAL

Fields inherited from class com.dpslink.flash.servlet.FlashServlet

SN_CART, SN_LOGON_STATUS, SN_SECPROFILE, SN_USER, SN_USERSFI

Fields inherited from class com.dpslink.base.servlet.BaseServlet

BROWSER_IE, BROWSER_NN, BROWSER_XX, RESP_NULL, RESP_REDIRECTED, RQST_AJAX, RQST_NULL

Constructor Summary

Constructors

Constructor and Description
QuickOrder()

Method Summary

Modifier and Type	Method and Description
private void	addToCart(QuickOrder.Context ctx) Handles processing for an add to cart request.
private void	addToCart(QuickOrder.Context ctx, CartLine cartline) Adds the given cart line to the database and to the session's cache of all cart lines.
private void	addToCartResponse(QuickOrder.Context ctx) Sends a JSON formatted response to the browser for an add to cart request.
private boolean	addToCartValidate(QuickOrder.Context ctx) Validates the submitted add to cart product values (product, units) with the Flash database and the ERP database.
private boolean	appendMessage(QuickOrder.Context ctx, java.lang.String msgname) Appends the text for the given message name to the current set of response messages.
protected MainServlet.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
protected boolean	editFormFields(BaseServlet.Context baseCtx) Edits the values from the html template's form fields.
private java.lang.String	formatCartLinePrice(QuickOrder.Context ctx, CartLine cartline) Returns a formatted price for the given cart line.
protected java.lang.String	getNextURL(BaseServlet.Context baseCtx) Returns the next URL (including parameters) to be processed when this servlet's processing has been successfully completed (no edit errors, etc.).
protected java.lang.String	getTemplateName(BaseServlet.Context baseCtx) Returns the name of the html template file used by the servlet.
protected void	readParameters(BaseServlet.Context baseCtx, boolean post) Reads the parameters passed to the servlet via the http request object.
private void	removeFromCart(QuickOrder.Context ctx) Handles processing for a remove from cart request.
private void	removeFromCartResponse(QuickOrder.Context ctx) Sends a JSON formatted response to the browser for a remove from cart request.
protected void	resetFormFields(BaseServlet.Context baseCtx) Resets the values for the html template's form fields.
private void	search(QuickOrder.Context ctx) Handles processing for an auto complete search request.
private void	searchResponse(QuickOrder.Context ctx, java.util.ArrayList<QuickOrder.SearchResult> results) Sends a JSON formatted response to the browser for an auto complete search request.
protected void	setCookieValues(BaseServlet.Context baseCtx) Adds one or more values to the http session cookies.
protected void	setSessionValues(BaseServlet.Context baseCtx) Adds one or more values to the http session object.
protected void	setTemplateData(BaseServlet.Context baseCtx) Sets the various data required by the html template.
private void	updateCart(QuickOrder.Context ctx) Handles processing for an update cart request.
private void	updateCartResponse(QuickOrder.Context ctx) Sends a JSON formatted response to the browser for an update cart request.
private void	writeResponse(QuickOrder.Context ctx, java.lang.String response) Writes a JSON formatted response to the http response output stream.

Methods inherited from class com.dpslink.flash.servlet.MainServlet

confirmSession, getPreviousCategoryList, getPreviousCategoryPath, hasSubcategories, hasSubcategories, isOmitNoStock, isPreshopRequest, isUserHelpRequest, setTemplateCategoryPath, sortCategoryProductData, writePageImpl

Methods inherited from class com.dpslink.flash.servlet.FlashServlet

confirmCart, confirmRequest, confirmRetail, confirmWholesale, createNewCart, createNewSessionImpl, getPageTitle, getServletPath, getUser, initTemplateDataImpl, isLogonRequest, requestComplete, requiresLogon, resetCart, resetCategories, resetProducts, setDefaultUser, setSessionCart, setSFIShoppingUser, useExistingSessionImpl, writeCookie

Methods inherited from class com.dpslink.base.servlet.BaseServlet

createNewSession, determineBrowser, doGet, doPost, getCookie, getInvokerName, getInvokerName, getInvokerParams, getInvokerParams, getInvokerPath, getInvokerPath, getInvokerURL, getPageParams, getRequestURL, getServletName, getServletName, getServletParams, getServletParams, getServletPath, getServletURL, getServletURL, getTemplateMessage, getTemplateMessage, getTemplateMessage, getTemplateMessage, getTemplateMessage, initTemplateData, isPrintable, isServerTomcat, log, qualifyURL, redirectURL, setP3PCompactPolicy, showSiteError, showSiteError, showSiteError, useExistingSession, writeCookie, writeTempCookie

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

QuickOrder

public QuickOrder()

Method Detail

editFormFields

protected boolean editFormFields(BaseServlet.Context baseCtx)

Edits the values from the html template's form fields. Invoked by the doPost method. Overrides editFormFields in BaseServlet.

Specified by:

editFormFields in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

boolean - true if all the edits are successful, otherwise false.

getNextURL

protected java.lang.String getNextURL(BaseServlet.Context baseCtx)

Returns the next URL (including parameters) to be processed when this servlet's processing has been successfully completed (no edit errors, etc.). Invoked by the writeURL method. Overrides getNextURL in BaseServlet.

Specified by:

getNextURL in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

String - The URL.

getTemplateName

protected java.lang.String getTemplateName(BaseServlet.Context baseCtx)

Returns the name of the html template file used by the servlet. Invoked by the writePage method. Overrides getTemplateName in BaseServlet.

Specified by:

getTemplateName in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

String - The html template's name.

readParameters

protected void readParameters(BaseServlet.Context baseCtx,
                              boolean post)

Reads the parameters passed to the servlet via the http request object. Invoked by the doGet and doPost method. Overrides readParameters in BaseServlet.

Specified by:

readParameters in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

post - (boolean) true if the method is invoked from doPost, otherwise false.

resetFormFields

protected void resetFormFields(BaseServlet.Context baseCtx)

Resets the values for the html template's form fields. Invoked by the doGet and doPost methods. Overrides resetFormFields in BaseServlet.

Specified by:

resetFormFields in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setCookieValues

protected void setCookieValues(BaseServlet.Context baseCtx)
                        throws java.io.IOException

Adds one or more values to the http session cookies. Invoked by the writeURL method. Calls should be made to writeCookie for each cookie that needs to be set. Overrides setCookieValues in BaseServlet.

Specified by:

setCookieValues in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Throws:

java.io.IOException - - if an error occurs when adding the cookie to the response header.

setSessionValues

protected void setSessionValues(BaseServlet.Context baseCtx)

Adds one or more values to the http session object. Invoked by the writeURL method. Overrides setSessionValues in BaseServlet.

Specified by:

setSessionValues in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setTemplateData

protected void setTemplateData(BaseServlet.Context baseCtx)

Sets the various data required by the html template. Invoked by the writePage method. Overrides setTemplateData in BaseServlet.

Specified by:

setTemplateData in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

addToCart

private void addToCart(QuickOrder.Context ctx)

Handles processing for an add to cart request.

Parameters:

ctx - (Context) The current servlet context.

addToCart

private void addToCart(QuickOrder.Context ctx,
                       CartLine cartline)
                throws java.lang.Exception

Adds the given cart line to the database and to the session's cache of all cart lines. Also sets variables used in the response to the browser.

Parameters:

ctx - (Context) The current servlet context.

cartline - (CartLine) The cart line to add.

Throws:

java.lang.Exception - - if a processing error occurs during the add.

addToCartResponse

private void addToCartResponse(QuickOrder.Context ctx)

Sends a JSON formatted response to the browser for an add to cart request.

Parameters:

ctx - (Context) The current servlet context.

addToCartValidate

private boolean addToCartValidate(QuickOrder.Context ctx)
                           throws java.lang.Exception

Validates the submitted add to cart product values (product, units) with the Flash database and the ERP database.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if no errors were detected or if only warning errors were detected, otherwise false.

Throws:

java.lang.Exception - - if a processing error occurs during the validation.

updateCart

private void updateCart(QuickOrder.Context ctx)

Handles processing for an update cart request.

Parameters:

ctx - (Context) The current servlet context.

updateCartResponse

private void updateCartResponse(QuickOrder.Context ctx)

Sends a JSON formatted response to the browser for an update cart request.

Parameters:

ctx - (Context) The current servlet context.

removeFromCart

private void removeFromCart(QuickOrder.Context ctx)

Handles processing for a remove from cart request.

Parameters:

ctx - (Context) The current servlet context.

removeFromCartResponse

private void removeFromCartResponse(QuickOrder.Context ctx)

Sends a JSON formatted response to the browser for a remove from cart request.

Parameters:

ctx - (Context) The current servlet context.

search

private void search(QuickOrder.Context ctx)

Handles processing for an auto complete search request.

Parameters:

ctx - (Context) The current servlet context.

searchResponse

private void searchResponse(QuickOrder.Context ctx,
                            java.util.ArrayList<QuickOrder.SearchResult> results)

Sends a JSON formatted response to the browser for an auto complete search request.

Parameters:

ctx - (Context) The current servlet context.

results - (ArrayList) The current set of search results.

appendMessage

private boolean appendMessage(QuickOrder.Context ctx,
                              java.lang.String msgname)

Appends the text for the given message name to the current set of response messages. The text for each appended messages is delimited by a vertical bar (|).

Parameters:

ctx - (Context) The current servlet context.

msgname - (String) The name of message to append. Used to determine which message (or messages) to retrieve from the message properties.

Returns:

boolean - Always returns false.

formatCartLinePrice

private java.lang.String formatCartLinePrice(QuickOrder.Context ctx,
                                             CartLine cartline)

Returns a formatted price for the given cart line.

Parameters:

ctx - (Context) The current servlet context.

cartline - (CartLine) The cart line to format.

Returns:

String - The formatted price.

writeResponse

private void writeResponse(QuickOrder.Context ctx,
                           java.lang.String response)

Writes a JSON formatted response to the http response output stream.

Parameters:

ctx - (Context) The current servlet context.

response - (String) The JSON response to write.

createContext

protected MainServlet.Context createContext(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)

Creates the servlet context inner class. Overrides createContext in MainServlet. Invoked by doPost and doGet methods.

Overrides:

createContext in class MainServlet

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Returns:

Context - The servlet context.