com.dpslink.flash.servlet

Class OrderRequestAPI

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.dpslink.flash.servlet.OrderRequestAPI

All Implemented Interfaces:

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

public class OrderRequestAPI
extends javax.servlet.http.HttpServlet

Servlet API for external access to order creation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OrderRequestAPI.Context Inner class used to store servlet context information.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	cvAllowUnknownProducts The allow unknown products flag - indicates whether Flash should accept products not in the product catalog.
private static java.text.SimpleDateFormat	cvCreditCardDateFormat A date formatter for dealing with credit card information.
private static boolean	cvDebug The debug flag.
private static java.text.SimpleDateFormat	cvISODateFormat A date formatter for dealing with credit card information.
private static boolean	cvShipToOneTime If the ship-to specified on the order is not currently on file, should it be added as one-time or permanent.
private static java.text.SimpleDateFormat	cvShortDateFormat A date formatter for dealing with credit card information.
private static java.lang.String	cvUnknownProductId The product id used as a placeholder (e.g.
private static java.lang.String	cvUnknownProductUom The unit of measure used as a placeholder (e.g.
private static java.lang.String	RFQ_ERRORMSG_PREF The request for quotation error message prefix.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
OrderRequestAPI()

Method Summary

Modifier and Type	Method and Description
private Customer	addShipto(OrderRequestAPI.Context ctx) Adds new ship-to customer based on information in the order request.
private void	addToSiteActivity(OrderRequestAPI.Context ctx) Adds the current order's values to the batch session's site activity order values.
protected OrderRequestAPI.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
private void	createSiteActivity(OrderRequestAPI.Context ctx) Records the initial site activity information for the batch session.
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles HTTP GET requests.
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles HTTP POST requests.
private Product	findProduct(OrderRequestAPI.Context ctx, OrderRequestLine reqline) Finds an existing product for an order request line.
private Customer	findShipto(OrderRequestAPI.Context ctx) Finds an existing customer that matches the requested ship-to.
java.lang.String	getServletInfo() Returns information about this servlet.
private void	queueSiteActivity(OrderRequestAPI.Context ctx, boolean post) Queues the session's activity for logging to the site activity history.
private java.lang.String	takeOrder(OrderRequestAPI.Context ctx) Creates a shopping cart and places an order.
private boolean	unknownProduct(OrderRequestAPI.Context ctx, OrderRequestLine reqline) Puts the placeholder product in the shopping cart.

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

RFQ_ERRORMSG_PREF

private static final java.lang.String RFQ_ERRORMSG_PREF

The request for quotation error message prefix.

See Also:

Constant Field Values

cvISODateFormat

private static final java.text.SimpleDateFormat cvISODateFormat

A date formatter for dealing with credit card information.

cvShortDateFormat

private static final java.text.SimpleDateFormat cvShortDateFormat

A date formatter for dealing with credit card information.

cvCreditCardDateFormat

private static final java.text.SimpleDateFormat cvCreditCardDateFormat

A date formatter for dealing with credit card information.

cvDebug

private static final boolean cvDebug

The debug flag. If true, provides additional logging.

cvAllowUnknownProducts

private static final boolean cvAllowUnknownProducts

The allow unknown products flag - indicates whether Flash should accept products not in the product catalog.

cvUnknownProductId

private static final java.lang.String cvUnknownProductId

The product id used as a placeholder (e.g. NA).

cvUnknownProductUom

private static final java.lang.String cvUnknownProductUom

The unit of measure used as a placeholder (e.g. EACH).

cvShipToOneTime

private static final boolean cvShipToOneTime

If the ship-to specified on the order is not currently on file, should it be added as one-time or permanent.

Constructor Detail

OrderRequestAPI

public OrderRequestAPI()

Method Detail

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.io.IOException,
                  javax.servlet.ServletException

Handles HTTP GET requests. Invoked by the servlet API. Should never be executed. If a get is called on this servlet, return a message that it is for internal use only.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

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

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

Throws:

java.io.IOException - - if an error occurs while processing the request or response.

javax.servlet.ServletException - - if an error occurs while processing the request or response.

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   java.io.IOException

Handles HTTP POST requests. Invoked by the servlet API.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

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

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

Throws:

java.io.IOException - - if an error occurs while processing the request or response.

javax.servlet.ServletException - - if an error occurs while processing the request or response.

getServletInfo

public java.lang.String getServletInfo()

Returns information about this servlet.

Specified by:

getServletInfo in interface javax.servlet.Servlet

Overrides:

getServletInfo in class javax.servlet.GenericServlet

Returns:

String - The description of this servlet.

takeOrder

private java.lang.String takeOrder(OrderRequestAPI.Context ctx)

Creates a shopping cart and places an order.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - Error message text, or null if no errors.

findProduct

private Product findProduct(OrderRequestAPI.Context ctx,
                            OrderRequestLine reqline)

Finds an existing product for an order request line.

Parameters:

ctx - (Context) The current servlet context.

reqline - (OrderRequestLine) The order request line having the product and uom to search.

Returns:

Product - The product or null if no product was found.

findShipto

private Customer findShipto(OrderRequestAPI.Context ctx)
                     throws java.lang.Exception

Finds an existing customer that matches the requested ship-to. If no match can be found, a new ship-to will be created.

Parameters:

ctx - (Context) The current servlet context.

Returns:

Customer - The ship-to customer.

Throws:

java.lang.Exception - - if an error occurs while retrieving the ship-to customer.

addShipto

private Customer addShipto(OrderRequestAPI.Context ctx)
                    throws java.lang.Exception

Adds new ship-to customer based on information in the order request.

Parameters:

ctx - (Context) The current servlet context.

Returns:

Customer - The ship-to customer.

Throws:

java.lang.Exception - - if an error occurs while adding the ship-to customer.

unknownProduct

private boolean unknownProduct(OrderRequestAPI.Context ctx,
                               OrderRequestLine reqline)

Puts the placeholder product in the shopping cart.

Parameters:

ctx - (Context) The current servlet context.

reqline - (OrderRequestLine) The current order request line.

addToSiteActivity

private void addToSiteActivity(OrderRequestAPI.Context ctx)

Adds the current order's values to the batch session's site activity order values.

Parameters:

ctx - (Context) The current servlet context.

createSiteActivity

private void createSiteActivity(OrderRequestAPI.Context ctx)

Records the initial site activity information for the batch session.

Parameters:

ctx - (Context) The current servlet context.

queueSiteActivity

private void queueSiteActivity(OrderRequestAPI.Context ctx,
                               boolean post)

Queues the session's activity for logging to the site activity history.

Parameters:

ctx - (Context) The current servlet context.

post - (boolean) true if the activity occurred during a POST operation, otherwise false.

createContext

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

Creates the servlet context inner class. Invoked by doPost method.

Parameters:

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

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

Returns:

Context - The servlet context.