com.dpslink.flash.servlet

Class OrderSummary

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AddToOpenOrder

public class OrderSummary
extends MainServlet

Writes and processes the store's order history summary page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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

FlashServlet.Stack

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ASCENDING The constant values used for order sorting.
private static java.lang.String[]	COLUMNS
private java.lang.String[]	cvDaysToIncludeCodes Order selection days codes.
private static java.lang.String	cvDaysToIncludeDefault The days-to-include default.
private java.lang.String[]	cvDaysToIncludeNames Order selection days names (descriptions).
private java.lang.String[]	cvOrdersToIncludeCodes Order selection inclusion codes.
private java.lang.String[]	cvOrdersToIncludeNames Order selection inclusion names (descriptions).
private static java.lang.String	DESCENDING
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
OrderSummary()

Method Summary

Modifier and Type	Method and Description
protected void	acSearch(OrderSummary.Context ctx) Handles processing for a product code auto complete search request.
protected void	acSearchResponse(OrderSummary.Context ctx, java.util.ArrayList<OrderSummary.acSearchResult> results) Sends a JSON formatted response to the browser for a product code auto complete search request.
protected void	acWriteResponse(OrderSummary.Context ctx, java.lang.String response) Writes a JSON formatted response to the http response output stream for a product code auto complete search request.
protected boolean	buildInitialOrderInfo1(OrderSummary.Context ctx) Builds initial list of orders requested via Order History function and creates the ctx.orders collection.
protected boolean	buildSortedOrderInfo2(OrderSummary.Context ctx, java.lang.String sortByColumn, java.lang.String sortType) Builds sorted list of orders requested via Order History function and modifies the ctx.orders collection.
protected boolean	buildSortedOrderInfo3(OrderSummary.Context ctx, java.lang.String sortByColumn, java.lang.String sortType, boolean sortAsc) Builds sorted list of orders requested via Order History function and modifies the ctx.orders collection.
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.
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 java.lang.String	getValueForOrderColumn(Order order, java.lang.String colname) Returns the string value for named column in the order.
protected void	readParameters(BaseServlet.Context baseCtx, boolean post) Reads the parameters passed to the servlet via the http request object.
protected boolean	requiresLogon(BaseServlet.Context baseCtx) Answers if the servlet requires a valid non-default user to log on in order to continue processing.
protected void	resetFormFields(BaseServlet.Context baseCtx) Resets the values for the html template's form fields.
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	setTemplateCustomerInfo(OrderSummary.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the customer data required by the html template.
protected void	setTemplateData(BaseServlet.Context baseCtx) Sets the various data required by the html template.
protected void	setTemplateOrderInfo0(OrderSummary.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the order summary data required by the html template.
protected void	setTemplateOrderInfo1(OrderSummary.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the order summary data required by the html template.
protected void	setTemplateOrderInfo2(OrderSummary.Context ctx, java.util.ArrayList<Order> orders) Sets the order summary data required by the html template.

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

cvOrdersToIncludeCodes

private final java.lang.String[] cvOrdersToIncludeCodes

Order selection inclusion codes.

cvOrdersToIncludeNames

private final java.lang.String[] cvOrdersToIncludeNames

Order selection inclusion names (descriptions).

cvDaysToIncludeCodes

private final java.lang.String[] cvDaysToIncludeCodes

Order selection days codes.

cvDaysToIncludeNames

private final java.lang.String[] cvDaysToIncludeNames

Order selection days names (descriptions).

cvDaysToIncludeDefault

private static final java.lang.String cvDaysToIncludeDefault

The days-to-include default.

ASCENDING

private static final java.lang.String ASCENDING

The constant values used for order sorting.

See Also:

Constant Field Values

DESCENDING

private static final java.lang.String DESCENDING

See Also:

Constant Field Values

COLUMNS

private static final java.lang.String[] COLUMNS

Constructor Detail

OrderSummary

public OrderSummary()

Method Detail

requiresLogon

protected boolean requiresLogon(BaseServlet.Context baseCtx)

Answers if the servlet requires a valid non-default user to log on in order to continue processing. The default is false for public shopping functions and true for admin, SAT and SFI/CSR functions. This method should be overridden by a subclass if the subclass requires something different than the default. Overrides requiresLogon in FlashServlet.

Overrides:

requiresLogon in class FlashServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

boolean - true if the servlet requires a non-default user to log on, otherwise false.

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.

setTemplateCustomerInfo

protected void setTemplateCustomerInfo(OrderSummary.Context ctx)

Invoked by this class' implementation of setTemplateData to retrieve and set the customer data required by the html template.

Parameters:

ctx - (Context) The current servlet context.

setTemplateOrderInfo0

protected void setTemplateOrderInfo0(OrderSummary.Context ctx)

Invoked by this class' implementation of setTemplateData to retrieve and set the order summary data required by the html template.

Parameters:

ctx - (Context) The current servlet context.

setTemplateOrderInfo1

protected void setTemplateOrderInfo1(OrderSummary.Context ctx)

Invoked by this class' implementation of setTemplateData to retrieve and set the order summary data required by the html template.

Parameters:

ctx - (Context) The current servlet context.

setTemplateOrderInfo2

protected void setTemplateOrderInfo2(OrderSummary.Context ctx,
                                     java.util.ArrayList<Order> orders)

Sets the order summary data required by the html template.

Parameters:

ctx - (Context) The current servlet context.

orders - (ArrayList) The set of orders to process.

buildInitialOrderInfo1

protected boolean buildInitialOrderInfo1(OrderSummary.Context ctx)

Builds initial list of orders requested via Order History function and creates the ctx.orders collection.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if initial order list was built successfully, otherwise false.

buildSortedOrderInfo2

protected boolean buildSortedOrderInfo2(OrderSummary.Context ctx,
                                        java.lang.String sortByColumn,
                                        java.lang.String sortType)

Builds sorted list of orders requested via Order History function and modifies the ctx.orders collection.

Parameters:

ctx - (Context) The current servlet context.

sortByColumn - (String) Sorting key.

sortType - (String) sort type (alpha, number or date).

Returns:

boolean - true if sorted order list was built successfully, otherwise false.

buildSortedOrderInfo3

protected boolean buildSortedOrderInfo3(OrderSummary.Context ctx,
                                        java.lang.String sortByColumn,
                                        java.lang.String sortType,
                                        boolean sortAsc)

Builds sorted list of orders requested via Order History function and modifies the ctx.orders collection.

Parameters:

ctx - (Context) The current servlet context.

sortByColumn - (String) Sorting key.

sortType - (String) sort type (alpha, number or date).

sortAsc - (boolean) true if sorting in ascending sequence, otherwise false.

Returns:

boolean - true if sorted order list was built successfully, otherwise false.

getValueForOrderColumn

protected java.lang.String getValueForOrderColumn(Order order,
                                                  java.lang.String colname)

Returns the string value for named column in the order.

Parameters:

order - (Order) The order.

colname - (String) The column name.

Returns:

String - the column value.

acSearch

protected void acSearch(OrderSummary.Context ctx)

Handles processing for a product code auto complete search request.

Parameters:

ctx - (Context) The current servlet context.

acSearchResponse

protected void acSearchResponse(OrderSummary.Context ctx,
                                java.util.ArrayList<OrderSummary.acSearchResult> results)

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

Parameters:

ctx - (Context) The current servlet context.

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

acWriteResponse

protected void acWriteResponse(OrderSummary.Context ctx,
                               java.lang.String response)

Writes a JSON formatted response to the http response output stream for a product code auto complete search request.

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.