Package com.softslate.commerce.customer.order

Class CheckoutAction

java.lang.Object

org.apache.struts.action.Action

com.softslate.commerce.customer.core.BaseAction

com.softslate.commerce.customer.order.CheckoutAction

Direct Known Subclasses:

AuthorizeNetDPMRelayResponseAction, AuthorizeNetDPMReturnAction, CheckoutAddressesAction, CheckoutAddressesFormAction, CheckoutComboAction, CheckoutComboFormAction, CheckoutComboShippingAction, CheckoutComboShippingFormAction, CheckoutConfirmAction, CheckoutDeclineLoginAction, CheckoutLoginAction, CheckoutLoginFormAction, CheckoutPaymentFormAction, CheckoutRegisterAction, CheckoutRegisterFormAction, CheckoutSettingsAction, CheckoutShippingAction, CheckoutShippingFormAction, CouponAction, PayPalExpressReturnAction, PaypointCallbackAction

public class CheckoutAction
extends BaseAction

Struts action class that corresponds to the store's checkout link. Used for requests to "/Checkout.do" and as a superclass for all of the other action classes in the checkout process.

The execute method of this class decides what checkout screen to direct the user to based on the status of the session and the store's database configuration.

The idea behind CheckoutAction is to provide a single superclass that manages nearly all of the forms and processing for the checkout process. This allows developers to easily create custom checkout screens by extending CheckoutAction, using its methods in different combinations.

To allow developers to more easily override these methods, a delegate pattern is used, in which most methods are delegated to CheckoutUtils and CheckoutUtilsImpl, which may be subclassed to implement custom functionality.

Author:

David Tobey

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static org.apache.commons.logging.Log	log

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor	Description
CheckoutAction()

Method Summary

Modifier and Type	Method	Description
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Forwards the user to the appropriate checkout screen based on the status of the session and the store's database settings.
Collection	loadShippingOptions(BaseForm baseForm)
void	prepareCheckoutAddressesForm(CheckoutAddressesForm baseForm)
void	prepareCheckoutShippingForm(BaseForm baseForm)
void	prepareLoginForm(BaseForm baseForm)
void	preparePaymentForm(org.apache.struts.action.ActionForm paymentForm, BaseForm baseForm)
void	preparePaymentForms(BaseForm baseForm)
void	prepareRegisterForm(BaseForm baseForm)
org.apache.struts.action.ActionForward	processCheckoutAddresses(BaseForm baseForm)
org.apache.struts.action.ActionForward	processCheckoutAddresses(BaseForm baseForm, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	processCheckoutConfirm(BaseForm baseForm)
org.apache.struts.action.ActionForward	processCheckoutLogin(BaseForm baseForm, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	processCheckoutPayment(BaseForm baseForm)
org.apache.struts.action.ActionForward	processCheckoutRegister(BaseForm baseForm)
org.apache.struts.action.ActionForward	processCheckoutShipping(BaseForm baseForm)
org.apache.struts.action.ActionForward	processDeclineLogin(BaseForm baseForm)
Map	processInventoryDiscountCheck(BaseForm baseForm)
Map	processOrderComplete(BaseForm baseForm)
int	processPayment(PaymentProcessor paymentProcessor, org.apache.struts.action.ActionForm paymentForm, BaseForm baseForm)
Map	processShipping(BaseForm baseForm)
Map	processTax(BaseForm baseForm)
boolean	validatePaymentForm(org.apache.struts.action.ActionForm paymentForm, BaseForm baseForm)

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Field Details

log

static org.apache.commons.logging.Log log

Constructor Details

CheckoutAction

public CheckoutAction()

Method Details

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
 org.apache.struts.action.ActionForm form,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
                                               throws Exception

Forwards the user to the appropriate checkout screen based on the status of the session and the store's database settings.

Overrides:

execute in class org.apache.struts.action.Action

Throws:

Exception

prepareLoginForm

public void prepareLoginForm(BaseForm baseForm)
                      throws Exception

Throws:

Exception

prepareRegisterForm

public void prepareRegisterForm(BaseForm baseForm)
                         throws Exception

Throws:

Exception

processCheckoutLogin

public org.apache.struts.action.ActionForward processCheckoutLogin(BaseForm baseForm,
 javax.servlet.http.HttpServletResponse response)
                                                            throws Exception

Throws:

Exception

processCheckoutRegister

public org.apache.struts.action.ActionForward processCheckoutRegister(BaseForm baseForm)
                                                               throws Exception

Throws:

Exception

processDeclineLogin

public org.apache.struts.action.ActionForward processDeclineLogin(BaseForm baseForm)
                                                           throws Exception

Throws:

Exception

loadShippingOptions

public Collection loadShippingOptions(BaseForm baseForm)
                               throws Exception

Throws:

Exception

prepareCheckoutAddressesForm

public void prepareCheckoutAddressesForm(CheckoutAddressesForm baseForm)
                                  throws Exception

Throws:

Exception

prepareCheckoutShippingForm

public void prepareCheckoutShippingForm(BaseForm baseForm)
                                 throws Exception

Throws:

Exception

processCheckoutAddresses

public org.apache.struts.action.ActionForward processCheckoutAddresses(BaseForm baseForm)
                                                                throws Exception

Throws:

Exception

processCheckoutAddresses

public org.apache.struts.action.ActionForward processCheckoutAddresses(BaseForm baseForm,
 javax.servlet.http.HttpServletResponse response)
                                                                throws Exception

Throws:

Exception

processInventoryDiscountCheck

public Map processInventoryDiscountCheck(BaseForm baseForm)
                                  throws Exception

Throws:

Exception

processCheckoutShipping

public org.apache.struts.action.ActionForward processCheckoutShipping(BaseForm baseForm)
                                                               throws Exception

Throws:

Exception

processShipping

public Map processShipping(BaseForm baseForm)
                    throws Exception

Throws:

Exception

processTax

public Map processTax(BaseForm baseForm)
               throws Exception

Throws:

Exception

preparePaymentForms

public void preparePaymentForms(BaseForm baseForm)
                         throws Exception

Throws:

Exception

preparePaymentForm

public void preparePaymentForm(org.apache.struts.action.ActionForm paymentForm,
 BaseForm baseForm)
                        throws Exception

Throws:

Exception

processCheckoutPayment

public org.apache.struts.action.ActionForward processCheckoutPayment(BaseForm baseForm)
                                                              throws Exception

Throws:

Exception

validatePaymentForm

public boolean validatePaymentForm(org.apache.struts.action.ActionForm paymentForm,
 BaseForm baseForm)
                            throws Exception

Throws:

Exception

processPayment

public int processPayment(PaymentProcessor paymentProcessor,
 org.apache.struts.action.ActionForm paymentForm,
 BaseForm baseForm)
                   throws Exception

Throws:

Exception

processCheckoutConfirm

public org.apache.struts.action.ActionForward processCheckoutConfirm(BaseForm baseForm)
                                                              throws Exception

Throws:

Exception

processOrderComplete

public Map processOrderComplete(BaseForm baseForm)
                         throws Exception

Throws:

Exception