CouponAction (SoftSlate Commerce API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.softslate.commerce.customer.order
Class CouponAction

java.lang.Object
  org.apache.struts.action.Action
      com.softslate.commerce.customer.core.BaseAction
          com.softslate.commerce.customer.order.CheckoutAction
              com.softslate.commerce.customer.order.CouponAction

public class CouponAction
extends CheckoutAction
extends CheckoutAction

Struts action class for submissions to record a coupon code entered by the user. Used for requests to "/CartCoupon.do" and "/CheckoutCoupon.do".

The execute method of this class first adds the submitted coupon code string to the enteredCouponCodes property of the current user's User instance. Next, it reprocesses discounts by invoking CartDiscountProcessor.processCouponCode(Map). Next, it checks the user's applied discounts to see if the coupon was applied. If it was not applied, an error is added to the request, the coupon code is removed from the enteredCouponCodes property, and the ActionForward returned will be named "failureCouponNotApplied". If the coupon is successfully applied, the "success" ActionForward is returned.

Author:: David Tobey

Field Summary
`(package private) static org.apache.commons.logging.Log`	`log`

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

Constructor Summary
`CouponAction()`

Method Summary
`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.

Methods inherited from class com.softslate.commerce.customer.order.CheckoutAction
`loadShippingOptions, prepareCheckoutAddressesForm, prepareCheckoutShippingForm, prepareLoginForm, preparePaymentForm, preparePaymentForms, prepareRegisterForm, processCheckoutAddresses, processCheckoutAddresses, processCheckoutConfirm, processCheckoutLogin, processCheckoutPayment, processCheckoutRegister, processCheckoutShipping, processDeclineLogin, processInventoryDiscountCheck, processOrderComplete, processPayment, processShipping, processTax, validatePaymentForm`

Methods inherited from class com.softslate.commerce.customer.order.CheckoutAction

loadShippingOptions, prepareCheckoutAddressesForm, prepareCheckoutShippingForm, prepareLoginForm, preparePaymentForm, preparePaymentForms, prepareRegisterForm, processCheckoutAddresses, processCheckoutAddresses, processCheckoutConfirm, processCheckoutLogin, processCheckoutPayment, processCheckoutRegister, processCheckoutShipping, processDeclineLogin, processInventoryDiscountCheck, processOrderComplete, processPayment, processShipping, processTax, validatePaymentForm

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 Detail

log

static org.apache.commons.logging.Log log

Constructor Detail

CouponAction

public CouponAction()

Method Detail

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 java.lang.Exception

Description copied from class: CheckoutAction

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 CheckoutAction

Throws:: java.lang.Exception