com.broadleafcommerce.rest.api.endpoint.order

Class CartEndpoint

java.lang.Object

com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

com.broadleafcommerce.rest.api.endpoint.order.CartEndpoint

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.MessageSourceAware

@FrameworkRestController
 @FrameworkMapping(value="/cart",
                  produces={"application/json","application/xml"})
public class CartEndpoint
extends BaseEndpoint

This endpoint depends on JAX-RS to provide cart services. It should be extended by components that actually wish to provide an endpoint. The annotations such as @Path, @Scope, @Context, @PathParam, @QueryParam,

Author:

Jay Aisenbrey (cja769)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.core.catalog.service.CatalogService	catalogService
protected org.broadleafcommerce.profile.core.service.CustomerService	customerService
protected org.broadleafcommerce.core.offer.service.OfferService	offerService
protected org.broadleafcommerce.core.order.service.OrderItemService	orderItemService
protected OrderRequestService	orderRequestService
protected org.broadleafcommerce.core.order.service.OrderService	orderService

Fields inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

context, messageSource

Constructor Summary

Constructors

Constructor and Description
CartEndpoint()

Method Summary

Modifier and Type	Method and Description
OrderWrapper	addItemToOrder(javax.servlet.http.HttpServletRequest request, Long cartId, OrderItemWrapper orderItemWrapper, Boolean priceOrder)
OrderWrapper	addOfferCode(javax.servlet.http.HttpServletRequest request, String promoCode, Long cartId, Boolean priceOrder)
ConfigurableOrderItemWrapper	configureItem(javax.servlet.http.HttpServletRequest request, Long productId)
OrderWrapper	createNewCartForCustomer(javax.servlet.http.HttpServletRequest request) Create a new Order for Customer
OrderWrapper	deleteOrderAttributes(javax.servlet.http.HttpServletRequest request, List<OrderAttributeWrapper> requestParams, Long cartId, Boolean priceOrder)
OrderWrapper	deleteProductOptions(javax.servlet.http.HttpServletRequest request, List<OrderItemAttributeWrapper> requestParams, Long cartId, Long itemId, Boolean priceOrder)
OrderWrapper	findCartById(javax.servlet.http.HttpServletRequest request, Long cartId)
OrderWrapper	findCartForCustomer(javax.servlet.http.HttpServletRequest request) Search for Order by Customer
protected Map<String,org.broadleafcommerce.core.order.domain.OrderAttribute>	getOrderAttributeMap(Map<String,String> options, org.broadleafcommerce.core.order.domain.Order order)
protected Map<String,org.broadleafcommerce.core.order.domain.OrderAttribute>	getRemainingOrderAttributes(Map<String,String> attrsToRemove, Map<String,org.broadleafcommerce.core.order.domain.OrderAttribute> attrs)
ConfigurableOrderItemWrapper	reconfigureItemFromOrder(javax.servlet.http.HttpServletRequest request, Long orderItemId)
OrderWrapper	removeAllOfferCodes(javax.servlet.http.HttpServletRequest request, Long cartId, boolean priceOrder)
OrderWrapper	removeItemFromOrder(javax.servlet.http.HttpServletRequest request, Long itemId, Long cartId, Boolean priceOrder)
OrderWrapper	removeOfferCode(javax.servlet.http.HttpServletRequest request, String promoCode, Long cartId, Boolean priceOrder)
OrderWrapper	updateItemQuantity(javax.servlet.http.HttpServletRequest request, Long itemId, Long cartId, Integer quantity, Boolean priceOrder)
OrderWrapper	updateOrderAttributes(javax.servlet.http.HttpServletRequest request, List<OrderAttributeWrapper> requestParams, Long cartId, Boolean priceOrder)
OrderWrapper	updateProductOptions(javax.servlet.http.HttpServletRequest request, List<OrderItemAttributeWrapper> requestParams, Long cartId, Long itemId, Boolean priceOrder)
protected OrderWrapper	wrapCart(javax.servlet.http.HttpServletRequest request, org.broadleafcommerce.core.order.domain.Order cart)

Methods inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

getApplicationContext, getMessageSource, setApplicationContext, setMessageSource

Methods inherited from class java.lang.Object

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

Field Detail

orderService

protected org.broadleafcommerce.core.order.service.OrderService orderService

offerService

protected org.broadleafcommerce.core.offer.service.OfferService offerService

orderItemService

protected org.broadleafcommerce.core.order.service.OrderItemService orderItemService

catalogService

protected org.broadleafcommerce.core.catalog.service.CatalogService catalogService

customerService

protected org.broadleafcommerce.profile.core.service.CustomerService customerService

orderRequestService

protected OrderRequestService orderRequestService

Constructor Detail

CartEndpoint

public CartEndpoint()

Method Detail

findCartForCustomer

@FrameworkMapping(value="",
                  method=GET)
public OrderWrapper findCartForCustomer(javax.servlet.http.HttpServletRequest request)

Search for Order by Customer

Returns:

the cart for the customer

createNewCartForCustomer

@FrameworkMapping(value="",
                  method=POST)
public OrderWrapper createNewCartForCustomer(javax.servlet.http.HttpServletRequest request)

Create a new Order for Customer

Returns:

the cart for the customer

findCartById

@FrameworkMapping(value="/{cartId}",
                  method=GET)
public OrderWrapper findCartById(javax.servlet.http.HttpServletRequest request,
                                                                                                    @PathVariable(value="cartId")
                                                                                                    Long cartId)

removeItemFromOrder

@FrameworkMapping(value="/{cartId}/items/{itemId}",
                  method=DELETE)
public OrderWrapper removeItemFromOrder(javax.servlet.http.HttpServletRequest request,
                                                                                                                             @PathVariable(value="itemId")
                                                                                                                             Long itemId,
                                                                                                                             @PathVariable(value="cartId")
                                                                                                                             Long cartId,
                                                                                                                             @RequestParam(value="priceOrder",required=false,defaultValue="true")
                                                                                                                             Boolean priceOrder)

updateItemQuantity

@FrameworkMapping(value="/{cartId}/items/{itemId}",
                  method=PUT)
public OrderWrapper updateItemQuantity(javax.servlet.http.HttpServletRequest request,
                                                                                                                         @PathVariable(value="itemId")
                                                                                                                         Long itemId,
                                                                                                                         @PathVariable(value="cartId")
                                                                                                                         Long cartId,
                                                                                                                         @RequestParam(value="quantity")
                                                                                                                         Integer quantity,
                                                                                                                         @RequestParam(value="priceOrder",required=false,defaultValue="true")
                                                                                                                         Boolean priceOrder)

addOfferCode

@FrameworkMapping(value="/{cartId}/offer/{promoCode}",
                  method=POST)
public OrderWrapper addOfferCode(javax.servlet.http.HttpServletRequest request,
                                                                                                                       @PathVariable(value="promoCode")
                                                                                                                       String promoCode,
                                                                                                                       @PathVariable(value="cartId")
                                                                                                                       Long cartId,
                                                                                                                       @RequestParam(value="priceOrder",required=false,defaultValue="true")
                                                                                                                       Boolean priceOrder)

removeOfferCode

@FrameworkMapping(value="/{cartId}/offer/{promoCode}",
                  method=DELETE)
public OrderWrapper removeOfferCode(javax.servlet.http.HttpServletRequest request,
                                                                                                                            @PathVariable(value="promoCode")
                                                                                                                            String promoCode,
                                                                                                                            @PathVariable(value="cartId")
                                                                                                                            Long cartId,
                                                                                                                            @RequestParam(value="priceOrder",required=false,defaultValue="true")
                                                                                                                            Boolean priceOrder)

removeAllOfferCodes

@FrameworkMapping(value="/{cartId}/offers",
                  method=DELETE)
public OrderWrapper removeAllOfferCodes(javax.servlet.http.HttpServletRequest request,
                                                                                                                     @PathVariable(value="cartId")
                                                                                                                     Long cartId,
                                                                                                                     @RequestParam(value="priceOrder",required=false,defaultValue="true")
                                                                                                                     boolean priceOrder)

updateProductOptions

@FrameworkMapping(value="/{cartId}/item/{itemId}/attributes",
                  method=PUT,
                  consumes={"application/json","application/xml"})
public OrderWrapper updateProductOptions(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                        @RequestBody
                                                                                                                                                                                                        List<OrderItemAttributeWrapper> requestParams,
                                                                                                                                                                                                        @PathVariable(value="cartId")
                                                                                                                                                                                                        Long cartId,
                                                                                                                                                                                                        @PathVariable(value="itemId")
                                                                                                                                                                                                        Long itemId,
                                                                                                                                                                                                        @RequestParam(value="priceOrder",required=false,defaultValue="true")
                                                                                                                                                                                                        Boolean priceOrder)

deleteProductOptions

@FrameworkMapping(value="/{cartId}/item/{itemId}/attributes",
                  method=DELETE,
                  consumes={"application/json","application/xml"})
public OrderWrapper deleteProductOptions(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                           @RequestBody(required=false)
                                                                                                                                                                                                           List<OrderItemAttributeWrapper> requestParams,
                                                                                                                                                                                                           @PathVariable(value="cartId")
                                                                                                                                                                                                           Long cartId,
                                                                                                                                                                                                           @PathVariable(value="itemId")
                                                                                                                                                                                                           Long itemId,
                                                                                                                                                                                                           @RequestParam(value="priceOrder",required=false,defaultValue="true")
                                                                                                                                                                                                           Boolean priceOrder)

updateOrderAttributes

@FrameworkMapping(value="/{cartId}/attributes",
                  method=PUT,
                  consumes={"application/json","application/xml"})
public OrderWrapper updateOrderAttributes(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                           @RequestBody
                                                                                                                                                                                           List<OrderAttributeWrapper> requestParams,
                                                                                                                                                                                           @PathVariable(value="cartId")
                                                                                                                                                                                           Long cartId,
                                                                                                                                                                                           @RequestParam(value="priceOrder",required=false,defaultValue="true")
                                                                                                                                                                                           Boolean priceOrder)

deleteOrderAttributes

@FrameworkMapping(value="/{cartId}/attributes",
                  method=DELETE,
                  consumes={"application/json","application/xml"})
public OrderWrapper deleteOrderAttributes(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                              List<OrderAttributeWrapper> requestParams,
                                                                                                                                                                                              @PathVariable(value="cartId")
                                                                                                                                                                                              Long cartId,
                                                                                                                                                                                              @RequestParam(value="priceOrder",required=false,defaultValue="true")
                                                                                                                                                                                              Boolean priceOrder)

getOrderAttributeMap

protected Map<String,org.broadleafcommerce.core.order.domain.OrderAttribute> getOrderAttributeMap(Map<String,String> options,
                                                                                                  org.broadleafcommerce.core.order.domain.Order order)

getRemainingOrderAttributes

protected Map<String,org.broadleafcommerce.core.order.domain.OrderAttribute> getRemainingOrderAttributes(Map<String,String> attrsToRemove,
                                                                                                         Map<String,org.broadleafcommerce.core.order.domain.OrderAttribute> attrs)

addItemToOrder

@FrameworkMapping(value="/{cartId}/item",
                  method=POST,
                  consumes={"application/json","application/xml"})
public OrderWrapper addItemToOrder(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                               @PathVariable(value="cartId")
                                                                                                                                                                               Long cartId,
                                                                                                                                                                               @RequestBody
                                                                                                                                                                               OrderItemWrapper orderItemWrapper,
                                                                                                                                                                               @RequestParam(value="priceOrder",required=false,defaultValue="true")
                                                                                                                                                                               Boolean priceOrder)

configureItem

public ConfigurableOrderItemWrapper configureItem(javax.servlet.http.HttpServletRequest request,
                                                  Long productId)

reconfigureItemFromOrder

public ConfigurableOrderItemWrapper reconfigureItemFromOrder(javax.servlet.http.HttpServletRequest request,
                                                             Long orderItemId)

wrapCart

protected OrderWrapper wrapCart(javax.servlet.http.HttpServletRequest request,
                                org.broadleafcommerce.core.order.domain.Order cart)