com.dpslink.flash.servlet.admin

Class AdmProductImportCandidateList

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

com.dpslink.flash.servlet.admin.AdmProductImportCandidateList

All Implemented Interfaces:

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

public class AdmProductImportCandidateList
extends MainPagingServlet

Writes and processes the admin product import candidate list page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdmProductImportCandidateList.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 long	serialVersionUID The class' serialization version id.
protected static java.lang.String	SN_PENDPROD_LIST The session's key for the current list of pending product objects.

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

Method Summary

Modifier and Type	Method and Description
protected MainPagingServlet.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
protected boolean	deselectAll(AdmProductImportCandidateList.Context ctx) Deselects all pending products in the batch.
protected boolean	deselectPage(AdmProductImportCandidateList.Context ctx) Deselects all pending products on the current page.
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 boolean	importBatch(AdmProductImportCandidateList.Context ctx) Handles processing for batch import requests.
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 boolean	selectAll(AdmProductImportCandidateList.Context ctx) Selects all pending products in the batch.
protected boolean	selectPage(AdmProductImportCandidateList.Context ctx) Selects all pending products on the current page.
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(AdmProductImportCandidateList.Context ctx, java.lang.String errName) Sets the html template error fields for the given error name.
protected boolean	updatePage(AdmProductImportCandidateList.Context ctx) Updates the pending products on the current page with the user's selections.

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

setTemplatePagingBegIndex, setTemplatePagingEndIndex, setTemplatePagingLinks

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_PENDPROD_LIST

protected static final java.lang.String SN_PENDPROD_LIST

The session's key for the current list of pending product objects.

See Also:

Constant Field Values

Constructor Detail

AdmProductImportCandidateList

public AdmProductImportCandidateList()

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(AdmProductImportCandidateList.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.

selectPage

protected boolean selectPage(AdmProductImportCandidateList.Context ctx)

Selects all pending products on the current page.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the selects are successful, otherwise false.

deselectPage

protected boolean deselectPage(AdmProductImportCandidateList.Context ctx)

Deselects all pending products on the current page.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the deselects are successful, otherwise false.

updatePage

protected boolean updatePage(AdmProductImportCandidateList.Context ctx)

Updates the pending products on the current page with the user's selections.

Parameters:

ctx - (Context) The current servlet context.

Returns:

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

selectAll

protected boolean selectAll(AdmProductImportCandidateList.Context ctx)

Selects all pending products in the batch.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the selects are successful, otherwise false.

deselectAll

protected boolean deselectAll(AdmProductImportCandidateList.Context ctx)

Deselects all pending products in the batch.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the deselects are successful, otherwise false.

importBatch

protected boolean importBatch(AdmProductImportCandidateList.Context ctx)
                       throws java.lang.Exception

Handles processing for batch import requests.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - always returns false so the template will be redisplayed.

Throws:

java.lang.Exception - - if an error occurs while processing the import request.

createContext

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

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

Overrides:

createContext in class MainPagingServlet

Parameters:

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

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

Returns:

Context - The servlet context.