Package de.hybris.platform.b2ctelcotmfwebservices.v3.controller

Class TmaProductOrderApiController

java.lang.Object

de.hybris.platform.b2ctelcotmfwebservices.v3.controller.TmaBaseController

de.hybris.platform.b2ctelcotmfwebservices.v3.controller.TmaProductOrderApiController

All Implemented Interfaces:

ProductOrderApi

@Controller
public class TmaProductOrderApiController
extends TmaBaseController
implements ProductOrderApi

Default implementation of ProductOrderApi

Since:

2205

Constructor Summary

Constructors

Constructor	Description
TmaProductOrderApiController(javax.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method	Description
protected TmaOrderFacade	getTmaOrderFacade()
protected org.springframework.transaction.PlatformTransactionManager	getTransactionManager()
protected org.springframework.transaction.support.TransactionTemplate	getTxTemplate()
org.springframework.http.ResponseEntity<List<ProductOrder>>	listProductOrder(@Valid String baseSiteId, @Valid String relatedPartyId, @Valid String orderDate, @Valid String state, @Valid String fields, @Valid Integer offset, @Valid Integer limit)
org.springframework.http.ResponseEntity<ProductOrder>	patchProductOrder(String id, @Valid ProductOrder productOrder, @Valid String baseSiteId)
org.springframework.http.ResponseEntity<ProductOrder>	productOrderCreate(@Valid ProductOrder productOrder, @Valid String baseSiteId)	An order resource is created and persisted.
org.springframework.http.ResponseEntity<ProductOrder>	retrieveProductOrder(String id, @Valid String fields, @Valid String relatedPartyId, @Valid String baseSiteId)

Methods inherited from class de.hybris.platform.b2ctelcotmfwebservices.v3.controller.TmaBaseController

addDefaultFields, encodeUrl, filter, getAuthentication, getDataMapper, getObjectMapper, getQueryStringWithoutOffsetAndLimit, getRequestUrl, getTmaCatalogVersionFacade, getUnsuccessfulResponse, getUnsuccessfulResponse, getUnsuccessfulResponseWithErrorRepresentation, getUser, handleInternalError, handleModelNotFoundException, handleTmaApiErrorInternal, init, sanitize, sanitizeQueryString, setCatalogVersion

Methods inherited from class java.lang.Object

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

Constructor Details

TmaProductOrderApiController

public TmaProductOrderApiController(javax.servlet.http.HttpServletRequest request)

Method Details

listProductOrder

@RequestMapping(value="/productOrder",
                produces="application/json;charset=utf-8",
                method=GET)
public org.springframework.http.ResponseEntity<List<ProductOrder>> listProductOrder(@Valid @RequestParam(value="baseSiteId",required=false)
 @Valid String baseSiteId,
 @Valid @RequestParam(value="relatedParty.id",required=false)
 @Valid String relatedPartyId,
 @Valid @RequestParam(value="orderDate",required=false)
 @Valid String orderDate,
 @Valid @RequestParam(value="state",required=false)
 @Valid String state,
 @Valid @RequestParam(value="fields",required=false)
 @Valid String fields,
 @Valid @RequestParam(value="offset",required=false)
 @Valid Integer offset,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit)

Specified by:

listProductOrder in interface ProductOrderApi

retrieveProductOrder

@RequestMapping(value="/productOrder/{id}",
                produces="application/json;charset=utf-8",
                method=GET)
public org.springframework.http.ResponseEntity<ProductOrder> retrieveProductOrder(@PathVariable("id")
 String id,
 @Valid @RequestParam(value="fields",required=false)
 @Valid String fields,
 @Valid @RequestParam(value="relatedParty.id",required=false)
 @Valid String relatedPartyId,
 @Valid @RequestParam(value="baseSiteId",required=false)
 @Valid String baseSiteId)

Specified by:

retrieveProductOrder in interface ProductOrderApi

patchProductOrder

@RequestMapping(value="/productOrder/{id}",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=PATCH)
public org.springframework.http.ResponseEntity<ProductOrder> patchProductOrder(@PathVariable("id")
 String id,
 @Valid @RequestBody
 @Valid ProductOrder productOrder,
 @Valid @RequestParam(value="baseSiteId",required=false)
 @Valid String baseSiteId)

Specified by:

patchProductOrder in interface ProductOrderApi

productOrderCreate

@RequestMapping(value="/productOrder",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=POST)
public org.springframework.http.ResponseEntity<ProductOrder> productOrderCreate(@Valid @RequestBody
 @Valid ProductOrder productOrder,
 @Valid @RequestParam(value="baseSiteId",required=false)
 @Valid String baseSiteId)

An order resource is created and persisted. Creation of an order resource is performed in 2 ways:
- creation of the order taking data from an existing shopping cart (provided in the request as a reference to the shopping cart resource)
- creation of the order with full data provided in the request

Specified by:

productOrderCreate in interface ProductOrderApi

Parameters:

productOrder - input storing data (reference to a cart resource or full order data) for creating the order resource

Returns:

resource order created in the format of a ProductOrder

getTmaOrderFacade

protected TmaOrderFacade getTmaOrderFacade()

getTxTemplate

protected org.springframework.transaction.support.TransactionTemplate getTxTemplate()

getTransactionManager

protected org.springframework.transaction.PlatformTransactionManager getTransactionManager()