org.broadleafcommerce.core.web.controller.cart

Class BroadleafCartController

java.lang.Object

org.broadleafcommerce.common.web.controller.BroadleafAbstractController

org.broadleafcommerce.core.web.controller.cart.AbstractCartController

org.broadleafcommerce.core.web.controller.cart.BroadleafCartController

public class BroadleafCartController
extends AbstractCartController

In charge of performing the various modify cart operations

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	cartPageRedirect
protected static java.lang.String	cartView

Fields inherited from class org.broadleafcommerce.core.web.controller.cart.AbstractCartController

catalogService, offerService, orderService, updateCartService

Constructor Summary

Constructors

Constructor and Description
BroadleafCartController()

Method Summary

Modifier and Type	Method and Description
java.lang.String	add(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, AddToCartItem itemRequest) Takes in an item request, adds the item to the customer's current cart, and returns.
java.lang.String	addPromo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, java.lang.String customerOffer) Attempts to add provided Offer to Cart
java.lang.String	addWithPriceOverride(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, AddToCartItem itemRequest) Takes in an item request, adds the item to the customer's current cart, and returns.
java.lang.String	cart(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model) Renders the cart page.
java.lang.String	empty(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model) Cancels the current cart and redirects to the homepage
java.lang.String	getCartPageRedirect()
java.lang.String	getCartView()
java.lang.String	remove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, AddToCartItem itemRequest) Takes in an item request, updates the quantity of that item in the cart, and returns If the method was invoked via an AJAX call, it will render the "ajax/cart" template.
java.lang.String	removePromo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, java.lang.Long offerCodeId) Removes offer from cart
java.lang.String	updateQuantity(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, AddToCartItem itemRequest) Takes in an item request and updates the quantity of that item in the cart.

Methods inherited from class org.broadleafcommerce.common.web.controller.BroadleafAbstractController

getContextPath, isAjaxRequest

Methods inherited from class java.lang.Object

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

Field Detail

cartView

protected static java.lang.String cartView

cartPageRedirect

protected static java.lang.String cartPageRedirect

Constructor Detail

BroadleafCartController

public BroadleafCartController()

Method Detail

cart

public java.lang.String cart(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             org.springframework.ui.Model model)
                      throws PricingException

Renders the cart page. If the method was invoked via an AJAX call, it will render the "ajax/cart" template. Otherwise, it will render the "cart" template. Will reprice the order if the currency has been changed.

Parameters:

request -

response -

model -

Throws:

PricingException

add

public java.lang.String add(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            org.springframework.ui.Model model,
                            AddToCartItem itemRequest)
                     throws java.io.IOException,
                            AddToCartException,
                            PricingException

Takes in an item request, adds the item to the customer's current cart, and returns. If the method was invoked via an AJAX call, it will render the "ajax/cart" template. Otherwise, it will perform a 302 redirect to "/cart"

Parameters:

request -

response -

model -

itemRequest -

Throws:

java.io.IOException

AddToCartException

PricingException

addWithPriceOverride

public java.lang.String addWithPriceOverride(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response,
                                             org.springframework.ui.Model model,
                                             AddToCartItem itemRequest)
                                      throws java.io.IOException,
                                             AddToCartException,
                                             PricingException

Takes in an item request, adds the item to the customer's current cart, and returns. Calls the addWithOverrides method on the orderService which will honor the override prices on the AddToCartItem request object. Implementors must secure this method to avoid accidentally exposing the ability for malicious clients to override prices by hacking the post parameters.

Parameters:

request -

response -

model -

itemRequest -

Throws:

java.io.IOException

AddToCartException

PricingException

updateQuantity

public java.lang.String updateQuantity(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response,
                                       org.springframework.ui.Model model,
                                       AddToCartItem itemRequest)
                                throws java.io.IOException,
                                       UpdateCartException,
                                       PricingException,
                                       RemoveFromCartException

Takes in an item request and updates the quantity of that item in the cart. If the quantity was passed in as 0, it will remove the item. If the method was invoked via an AJAX call, it will render the "ajax/cart" template. Otherwise, it will perform a 302 redirect to "/cart"

Parameters:

request -

response -

model -

itemRequest -

Throws:

java.io.IOException

PricingException

UpdateCartException

RemoveFromCartException

remove

public java.lang.String remove(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               org.springframework.ui.Model model,
                               AddToCartItem itemRequest)
                        throws java.io.IOException,
                               PricingException,
                               RemoveFromCartException

Takes in an item request, updates the quantity of that item in the cart, and returns If the method was invoked via an AJAX call, it will render the "ajax/cart" template. Otherwise, it will perform a 302 redirect to "/cart"

Parameters:

request -

response -

model -

itemRequest -

Throws:

java.io.IOException

PricingException

RemoveFromCartException

empty

public java.lang.String empty(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              org.springframework.ui.Model model)
                       throws PricingException

Cancels the current cart and redirects to the homepage

Parameters:

request -

response -

model -

Throws:

PricingException

addPromo

public java.lang.String addPromo(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 org.springframework.ui.Model model,
                                 java.lang.String customerOffer)
                          throws java.io.IOException,
                                 PricingException

Attempts to add provided Offer to Cart

Parameters:

request -

response -

model -

customerOffer -

Returns:

the return view

Throws:

java.io.IOException

PricingException

ItemNotFoundException

OfferMaxUseExceededException

removePromo

public java.lang.String removePromo(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    org.springframework.ui.Model model,
                                    java.lang.Long offerCodeId)
                             throws java.io.IOException,
                                    PricingException

Removes offer from cart

Parameters:

request -

response -

model -

Returns:

the return view

Throws:

java.io.IOException

PricingException

ItemNotFoundException

OfferMaxUseExceededException

getCartView

public java.lang.String getCartView()

getCartPageRedirect

public java.lang.String getCartPageRedirect()