Package org.openwms.wms.shipping

Class ShippingController

java.lang.Object

org.openwms.core.http.AbstractWebController

org.openwms.wms.shipping.ShippingController

@Validated
@MeasuredRestController
class ShippingController
extends org.openwms.core.http.AbstractWebController

A ShippingController.

Author:

Heiko Scherrer

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOGGER
private final ShippingMapper	mapper
private final ShippingService	shipping
private final jakarta.validation.Validator	validator

Constructor Summary

Constructors

Constructor	Description
ShippingController(ShippingService shipping, ShippingMapper mapper, jakarta.validation.Validator validator)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	createOrder(ShippingOrderVO vo, jakarta.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<ShippingOrderVO>	findByOrderId(String orderId)
org.springframework.http.ResponseEntity<ShippingOrderVO>	findByPKey(String pKey)
org.springframework.http.ResponseEntity<org.openwms.core.http.Index>	index()
org.springframework.http.ResponseEntity<ShippingOrderVO>	updateOrderPartially(String pKey, ShippingOrderVO shippingOrder)

Methods inherited from class org.openwms.core.http.AbstractWebController

buildNOKResponse, buildNOKResponseWithKey, buildOKResponse, buildResponse, buildResponse, getLocationForCreatedResource, getLocationURIForCreatedResource, handleBehaviorAwareException, handleBusinessRuntimeException, handleConstraintViolationException, handleException, handleHttpBusinessException, handleRemovalNotAllowedException, handleTechnicalRuntimeException, handleValidationException, illegalArgumentException, translate

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

shipping

private final ShippingService shipping

mapper

private final ShippingMapper mapper

validator

private final jakarta.validation.Validator validator

Constructor Details

ShippingController

ShippingController(ShippingService shipping,
 ShippingMapper mapper,
 jakarta.validation.Validator validator)

Method Details

index

@GetMapping("/v1/shipping-orders/index")
public org.springframework.http.ResponseEntity<org.openwms.core.http.Index> index()
                                                                           throws URISyntaxException

Throws:

URISyntaxException

findByPKey

@GetMapping("/v1/shipping-orders/{pKey}")
@Transactional(readOnly=true)
public org.springframework.http.ResponseEntity<ShippingOrderVO> findByPKey(@PathVariable("pKey")
 String pKey)

findByOrderId

@GetMapping(value="/v1/shipping-orders",
            params="orderId",
            produces="application/vnd.openwms.shipping-order-v1+json")
@Transactional(readOnly=true)
public org.springframework.http.ResponseEntity<ShippingOrderVO> findByOrderId(@RequestParam("orderId")
 String orderId)

createOrder

@PostMapping("/v1/shipping-orders")
public org.springframework.http.ResponseEntity<Void> createOrder(@RequestBody
 ShippingOrderVO vo,
 jakarta.servlet.http.HttpServletRequest request)
                                                          throws URISyntaxException

Throws:

URISyntaxException

updateOrderPartially

@PatchMapping("/v1/shipping-orders/{pKey}")
@Transactional
public org.springframework.http.ResponseEntity<ShippingOrderVO> updateOrderPartially(@PathVariable("pKey")
 String pKey,
 @RequestBody
 ShippingOrderVO shippingOrder)