com.broadleafcommerce.rest.api.endpoint.order

Class OrderHistoryEndpoint

java.lang.Object

com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

com.broadleafcommerce.rest.api.endpoint.order.OrderHistoryEndpoint

All Implemented Interfaces:

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

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

This endpoint depends on JAX-RS. 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.order.service.OrderService	orderService

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

context, messageSource

Constructor Summary

Constructors

Constructor and Description
OrderHistoryEndpoint()

Method Summary

Modifier and Type	Method and Description
List<OrderWrapper>	findAllOrdersForCustomer(javax.servlet.http.HttpServletRequest request) Finds all of the orders for the customer set on the request
OrderWrapper	findOrderById(javax.servlet.http.HttpServletRequest request, Long orderId) Finds order, if it exists, whose id is orderId
protected OrderWrapper	findOrderByOrderNumber(javax.servlet.http.HttpServletRequest request, String orderNumber)
List<OrderWrapper>	findOrdersForCustomer(javax.servlet.http.HttpServletRequest request, String orderStatus, String orderNumber) Finds all of the orders with an order status of orderStatus for the customer set on the request

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

Constructor Detail

OrderHistoryEndpoint

public OrderHistoryEndpoint()

Method Detail

findOrdersForCustomer

@FrameworkMapping(method=GET)
public List<OrderWrapper> findOrdersForCustomer(javax.servlet.http.HttpServletRequest request,
                                                                              @RequestParam(value="orderStatus",defaultValue="SUBMITTED")
                                                                              String orderStatus,
                                                                              @RequestParam(value="orderNumber",required=false)
                                                                              String orderNumber)

Finds all of the orders with an order status of orderStatus for the customer set on the request

Parameters:

request -

orderStatus -

Returns:

Throws:

400 - Bad Request if customerId isn't set on the request

findOrderByOrderNumber

protected OrderWrapper findOrderByOrderNumber(javax.servlet.http.HttpServletRequest request,
                                              String orderNumber)

findAllOrdersForCustomer

@FrameworkMapping(value="/summary",
                  method=GET)
public List<OrderWrapper> findAllOrdersForCustomer(javax.servlet.http.HttpServletRequest request)

Finds all of the orders for the customer set on the request

Parameters:

request -

Returns:

Throws:

400 - Bad Request if the customer isn't set on the request

findOrderById

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

Finds order, if it exists, whose id is orderId

Parameters:

request -

orderId -

Returns:

Throws:

404 - Not Found if no cart with id of orderId exists