com.dpslink.flash.servlet

Class ProductDetails

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

All Implemented Interfaces:

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

public class ProductDetails
extends MainServlet

Writes and processes the store's product details page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProductDetails.Context Inner class used to store servlet context information.
class	ProductDetails.DisplayableAttribute Inner class used to define a displayable product attribute.

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.
static java.lang.String	SN_PRODUCT The session's key for the current product value.
protected static java.lang.String	SN_RELPRODUCTS The session's key for a product's current set of related products value.

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
ProductDetails()

Method Summary

Modifier and Type	Method and Description
protected boolean	addToStockNotification(ProductDetails.Context ctx) Processes a request for stock notification and, if no errors occur, adds the request to the restock notification table.
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 Product	getProductFromDb(ProductDetails.Context ctx, java.lang.String code, java.lang.String uom) Retrieves the requested product from the database.
protected java.lang.String	getTemplateName(BaseServlet.Context baseCtx) Returns the name of the html template file used by the servlet.
protected java.lang.String	getUserEmailAddress(ProductDetails.Context ctx) Determine the correct email address to use for this session & user.
protected boolean	processCart(ProductDetails.Context ctx, java.util.ArrayList<Product> products, java.util.ArrayList<java.lang.Integer> quantities, java.util.ArrayList<UnitMeasure> orderuoms, java.util.ArrayList<UnitMeasure> priceuoms) Performs the requested cart or favorites processing.
protected boolean	processMainProduct(ProductDetails.Context ctx) Retrieves the submitted values for the main product and then adds the product to the cart or favorites.
protected boolean	processRelatedProduct(ProductDetails.Context ctx) Retrieves the submitted values for a single related product and then adds the product to the cart or favorites.
protected boolean	processRelatedProducts(ProductDetails.Context ctx) Retrieves the submitted values for any selected related products and then adds the products to the cart or favorites.
protected void	readParameters(BaseServlet.Context baseCtx, boolean post) Reads the parameters passed to the servlet via the http request object.
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	setTemplateData(BaseServlet.Context baseCtx) Sets the various data required by the html template.
protected boolean	setTemplateError(ProductDetails.Context ctx, java.lang.String errName) Sets the html template error fields for the given error name.
protected void	setTemplateFavorites(ProductDetails.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the favorites data required by the html template.
protected void	setTemplateOnOrderFromSupplier(ProductDetails.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the on order information from supplier data required by the html template.
protected void	setTemplateProduct(ProductDetails.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the product data required by the html template.
protected void	setTemplateProductAttributes(ProductDetails.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the product attributes data required by the html template.
protected void	setTemplateQuantityBreaks(ProductDetails.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the quantity price break data required by the html template.
protected boolean	setTemplateRelatedProducts(ProductDetails.Context ctx, boolean inclSelectable) Invoked by this class' implementation of setTemplateData to retrieve and set the related products data required by the html template.
protected void	setTemplateWarehouseQuantities(ProductDetails.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the warehouse quantity 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, 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

SN_PRODUCT

public static final java.lang.String SN_PRODUCT

The session's key for the current product value.

See Also:

Constant Field Values

SN_RELPRODUCTS

protected static final java.lang.String SN_RELPRODUCTS

The session's key for a product's current set of related products value.

See Also:

Constant Field Values

Constructor Detail

ProductDetails

public ProductDetails()

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.

setTemplateError

protected boolean setTemplateError(ProductDetails.Context ctx,
                                   java.lang.String errName)

Sets the html template error fields for the given error name.

Parameters:

ctx - (Context) The current servlet context.

errName - (String) The name of error that is to be set, used to determine which message (or messages) to retrieve from the message properties.

Returns:

boolean - Always returns false.

setTemplateProduct

protected void setTemplateProduct(ProductDetails.Context ctx)

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

Parameters:

ctx - (Context) The current servlet context.

getUserEmailAddress

protected java.lang.String getUserEmailAddress(ProductDetails.Context ctx)

Determine the correct email address to use for this session & user.

Parameters:

ctx - (Context) The servlet's current context.

Returns:

String - email address or blanks if it cannot be determined.

setTemplateProductAttributes

protected void setTemplateProductAttributes(ProductDetails.Context ctx)

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

Parameters:

ctx - (Context) The servlet's current context.

setTemplateQuantityBreaks

protected void setTemplateQuantityBreaks(ProductDetails.Context ctx)

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

Note: This method is overridden by CDProductDetails. Any significant changes made here may also need to be made in the overridden version.

Parameters:

ctx - (Context) The servlet's current context.

setTemplateWarehouseQuantities

protected void setTemplateWarehouseQuantities(ProductDetails.Context ctx)

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

Parameters:

ctx - (Context) The servlet's current context.

setTemplateOnOrderFromSupplier

protected void setTemplateOnOrderFromSupplier(ProductDetails.Context ctx)

Invoked by this class' implementation of setTemplateData to retrieve and set the on order information from supplier data required by the html template.

Parameters:

ctx - (Context) The servlet's current context.

setTemplateFavorites

protected void setTemplateFavorites(ProductDetails.Context ctx)

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

Parameters:

ctx - (Context) The current servlet context.

setTemplateRelatedProducts

protected boolean setTemplateRelatedProducts(ProductDetails.Context ctx,
                                             boolean inclSelectable)

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

Parameters:

ctx - (Context) The servlet's current context.

inclSelectable - (boolean) true if selectable related products can be selected and added to the cart or favorites, otherwise false.

Returns:

boolean - true if the related product information is successfully retrieved and set, otherwise false.

addToStockNotification

protected boolean addToStockNotification(ProductDetails.Context ctx)

Processes a request for stock notification and, if no errors occur, adds the request to the restock notification table.

Parameters:

ctx - (Context) The servlet's current context.

Returns:

boolean - always returns false.

getProductFromDb

protected Product getProductFromDb(ProductDetails.Context ctx,
                                   java.lang.String code,
                                   java.lang.String uom)

Retrieves the requested product from the database.

Parameters:

ctx - (Context) The servlet's current context.

code - (String) The product code for the desired record.

uom - (String) The unit of measure code for the desired record.

Returns:

Product - The Product object for the requested product, or null if the product was not retrieved.

processCart

protected boolean processCart(ProductDetails.Context ctx,
                              java.util.ArrayList<Product> products,
                              java.util.ArrayList<java.lang.Integer> quantities,
                              java.util.ArrayList<UnitMeasure> orderuoms,
                              java.util.ArrayList<UnitMeasure> priceuoms)

Performs the requested cart or favorites processing.

Parameters:

ctx - (Context) The servlet's current context.

products - (ArrayList) The products to process.

quantities - (ArrayList) The quantities to process.

orderuoms - (ArrayList) The order units of measure to process.

priceuoms - (ArrayList) The price units of measure to process.

Returns:

boolean - true if the processing is successful, otherwise false.

processMainProduct

protected boolean processMainProduct(ProductDetails.Context ctx)

Retrieves the submitted values for the main product and then adds the product to the cart or favorites.

Parameters:

ctx - (Context) The servlet's current context.

Returns:

boolean - true if the product is successfully added, otherwise false.

processRelatedProduct

protected boolean processRelatedProduct(ProductDetails.Context ctx)

Retrieves the submitted values for a single related product and then adds the product to the cart or favorites.

Parameters:

ctx - (Context) The servlet's current context.

Returns:

boolean - true if the product is successfully added, otherwise false.

processRelatedProducts

protected boolean processRelatedProducts(ProductDetails.Context ctx)

Retrieves the submitted values for any selected related products and then adds the products to the cart or favorites.

Parameters:

ctx - (Context) The servlet's current context.

Returns:

boolean - true if the products are successfully added, otherwise false.

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.