Package de.hybris.platform.ycommercewebservices.v2.controller

Class OrdersController

java.lang.Object

de.hybris.platform.ycommercewebservices.v2.controller.BaseController

de.hybris.platform.ycommercewebservices.v2.controller.BaseCommerceController

de.hybris.platform.ycommercewebservices.v2.controller.OrdersController

@Controller
@RequestMapping("/{baseSiteId}")
public class OrdersController
extends BaseCommerceController

Web Service Controller for the ORDERS resource. Most methods check orders of the user. Methods require authentication and are restricted to https channel.

Field Summary

Fields inherited from class de.hybris.platform.ycommercewebservices.v2.controller.BaseController

BASIC_FIELD_SET, DEFAULT_CURRENT_PAGE, DEFAULT_FIELD_SET, DEFAULT_PAGE_SIZE, HEADER_TOTAL_COUNT

Constructor Summary

Constructors

Constructor	Description
OrdersController()

Method Summary

Modifier and Type	Method	Description
void	countUserOrders(java.lang.String statuses, javax.servlet.http.HttpServletResponse response)
OrderWsDTO	getOrder(java.lang.String code, java.lang.String fields)
OrderHistoryListWsDTO	getUserOrderHistory(java.lang.String statuses, int currentPage, int pageSize, java.lang.String sort, java.lang.String fields, javax.servlet.http.HttpServletResponse response)
OrderWsDTO	getUserOrders(java.lang.String code, java.lang.String fields)
OrderWsDTO	placeOrder(java.lang.String cartId, java.lang.String fields)

Methods inherited from class de.hybris.platform.ycommercewebservices.v2.controller.BaseCommerceController

addPaymentDetailsInternal, addPaymentDetailsInternal, applyVoucherForCartInternal, createAddressInternal, createAddressInternal, getAddressDTOValidator, getAddressValidator, getCartFacade, getCcPaymentInfoValidator, getCheckoutFacade, getDeliveryAddressValidator, getHttpRequestAddressDataPopulator, getHttpRequestPaymentInfoPopulator, getPaymentDetailsDTOValidator, getSessionCart, getUserFacade, getVoucherFacade, setAddressDTOValidator, setAddressValidator, setCartDeliveryAddressInternal, setCartDeliveryModeInternal, setCartFacade, setCcPaymentInfoValidator, setCheckoutFacade, setDeliveryAddressValidator, setHttpRequestAddressDataPopulator, setHttpRequestPaymentInfoPopulator, setPaymentDetailsDTOValidator, setPaymentDetailsInternal, setUserFacade, setVoucherFacade, validateCartForPlaceOrder, validateStatusesEnumValue

Methods inherited from class de.hybris.platform.ycommercewebservices.v2.controller.BaseController

addPaginationField, getDataMapper, handleDuplicateUidException, handleErrorInternal, handleModelNotFoundException, logParam, logParam, logParam, logValue, sanitize, setDataMapper, setTotalCountHeader, setTotalCountHeader, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

OrdersController

public OrdersController()

Method Detail

getOrder

@Secured("ROLE_TRUSTED_CLIENT")
@RequestMapping(value="/orders/{code}",
                method=GET)
@Cacheable(value="orderCache",
           key="T(de.hybris.platform.commercewebservicescommons.cache.CommerceCacheKeyGenerator).generateKey(false,true,\'getOrder\',#code,#fields)")
@ResponseBody
public OrderWsDTO getOrder(@PathVariable
                           java.lang.String code,
                           @RequestParam(defaultValue="DEFAULT")
                           java.lang.String fields)

getUserOrders

@Secured({"ROLE_CUSTOMERGROUP","ROLE_GUEST","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/users/{userId}/orders/{code}",
                method=GET)
@Cacheable(value="orderCache",
           key="T(de.hybris.platform.commercewebservicescommons.cache.CommerceCacheKeyGenerator).generateKey(true,true,\'getOrderForUserByCode\',#code,#fields)")
@ResponseBody
public OrderWsDTO getUserOrders(@PathVariable
                                java.lang.String code,
                                @RequestParam(defaultValue="DEFAULT")
                                java.lang.String fields)

getUserOrderHistory

@Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/users/{userId}/orders",
                method=GET)
@ResponseBody
public OrderHistoryListWsDTO getUserOrderHistory(@RequestParam(required=false)
                                                 java.lang.String statuses,
                                                 @RequestParam(defaultValue="0")
                                                 int currentPage,
                                                 @RequestParam(defaultValue="20")
                                                 int pageSize,
                                                 @RequestParam(required=false)
                                                 java.lang.String sort,
                                                 @RequestParam(defaultValue="DEFAULT")
                                                 java.lang.String fields,
                                                 javax.servlet.http.HttpServletResponse response)

countUserOrders

@Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/users/{userId}/orders",
                method=HEAD)
@ResponseBody
public void countUserOrders(@RequestParam(required=false)
                            java.lang.String statuses,
                            javax.servlet.http.HttpServletResponse response)

placeOrder

@Secured({"ROLE_CUSTOMERGROUP","ROLE_CLIENT","ROLE_CUSTOMERMANAGERGROUP","ROLE_TRUSTED_CLIENT"})
@RequestMapping(value="/users/{userId}/orders",
                method=POST)
@ResponseStatus(CREATED)
@ResponseBody
public OrderWsDTO placeOrder(@RequestParam
                             java.lang.String cartId,
                             @RequestParam(defaultValue="DEFAULT")
                             java.lang.String fields)
                      throws InvalidCartException,
                             NoCheckoutCartException

Throws:

InvalidCartException

NoCheckoutCartException