Package org.openwms.common.transport.api

Interface TransportUnitApi

@FeignClient(name="common-service",
             qualifiers="transportUnitApi")
public interface TransportUnitApi

A TransportUnitApi is the public REST API to manage TransportUnits. It is implemented by a Feign client stub.

Author:

Heiko Scherrer

Method Summary

Modifier and Type	Method	Description
void	addErrorToTransportUnit(String transportUnitBK, String errorCode)	Add an error message to a TransportUnit.
void	blockTransportUnit(String transportUnitBK)	Set the state of a TransportUnit to BLOCKED.
void	createTU(String transportUnitBK, String actualLocation, String tut, Boolean strict)	Create a TransportUnit with the given (minimal) information.
void	createTU(String transportUnitBK, TransportUnitVO tu, Boolean strict)	Create a TransportUnit with the given business key (Barcode).
TransportUnitVO	findTransportUnit(String transportUnitBK)	Find and return a TransportUnit identified by its business key (Barcode).
List<TransportUnitVO>	findTransportUnits(List<String> transportUnitBKs)	Find and return all TransportUnit identified by their business keys (Barcodes).
List<TransportUnitVO>	findTransportUnitsOn(String actualLocation)	Find and return all TransportUnits that are booked on the given Location.
TransportUnitVO	moveTU(String transportUnitBK, String newLocation)	Move a TransportUnit from its current location to the newLocation.
void	qcTransportUnit(String transportUnitBK)	Set the state of a TransportUnit to QUALITY_CHECK.
void	unblockTransportUnit(String transportUnitBK)	Set the state of a TransportUnit to AVAILABLE.
TransportUnitVO	updateTU(String transportUnitBK, TransportUnitVO tu)	Update an existing TransportUnit.

Method Details

findTransportUnit

@GetMapping(value="/v1/transport-units",
            params="bk",
            produces="application/vnd.openwms.transport-unit-v1+json")
TransportUnitVO findTransportUnit(@RequestParam("bk")
 String transportUnitBK)

Find and return a TransportUnit identified by its business key (Barcode).

Parameters:

transportUnitBK - The unique (physical) identifier

Returns:

The instance or the implementation may return a 404-Not Found

findTransportUnits

@GetMapping(value="/v1/transport-units",
            params="bks",
            produces="application/vnd.openwms.transport-unit-v1+json")
List<TransportUnitVO> findTransportUnits(@RequestParam("bks")
 List<String> transportUnitBKs)

Find and return all TransportUnit identified by their business keys (Barcodes).

Parameters:

transportUnitBKs - The unique (physical) identifiers

Returns:

All TransportUnits or an empty List never null

findTransportUnitsOn

@GetMapping(value="/v1/transport-units",
            params="actualLocation",
            produces="application/vnd.openwms.transport-unit-v1+json")
List<TransportUnitVO> findTransportUnitsOn(@RequestParam("actualLocation")
 String actualLocation)

Find and return all TransportUnits that are booked on the given Location.

Parameters:

actualLocation - The Location to search for TransportUnits

Returns:

All TransportUnits on that Location or an empty List never null

createTU

@PostMapping(value="/v1/transport-units",
             params="bk")
void createTU(@RequestParam("bk")
 String transportUnitBK,
 @RequestBody
 TransportUnitVO tu,
 @RequestParam(value="strict",required=false)
 Boolean strict)

Create a TransportUnit with the given business key (Barcode).

Parameters:

transportUnitBK - The unique (physical) identifier

tu - Detailed information of the TransportUnit to create

strict - If the TransportUnit already exists and this is true an error is thrown. If false, the implementation exists silently (default)

createTU

@PostMapping(value="/v1/transport-units",
             params={"bk","actualLocation","tut"})
void createTU(@RequestParam("bk")
 String transportUnitBK,
 @RequestParam("actualLocation")
 String actualLocation,
 @RequestParam("tut")
 String tut,
 @RequestParam(value="strict",required=false)
 Boolean strict)

Create a TransportUnit with the given (minimal) information.

Parameters:

transportUnitBK - The unique (physical) identifier

actualLocation - The current location of the TransportUnit

tut - The type (TransportUnitType

strict - If the TransportUnit already exists and this is true an error is thrown. If false, the implementation exists silently (default)

updateTU

@PutMapping(value="/v1/transport-units",
            params="bk")
TransportUnitVO updateTU(@RequestParam("bk")
 String transportUnitBK,
 @RequestBody
 TransportUnitVO tu)

Update an existing TransportUnit.

Parameters:

transportUnitBK - The unique (physical) identifier

tu - Detailed structure of the TransportUnit to create

Returns:

The updated instance

moveTU

@PatchMapping(value="/v1/transport-units",
              params={"bk","newLocation"})
TransportUnitVO moveTU(@RequestParam("bk")
 String transportUnitBK,
 @RequestParam("newLocation")
 String newLocation)

Move a TransportUnit from its current location to the newLocation.

Parameters:

transportUnitBK - The unique (physical) identifier

newLocation - The new Location to move to

Returns:

The updated instance

addErrorToTransportUnit

@PostMapping(value="/v1/transport-unit/error",
             params={"bk","errorCode"})
void addErrorToTransportUnit(@RequestParam("bk")
 String transportUnitBK,
 @RequestParam("errorCode")
 String errorCode)

Add an error message to a TransportUnit.

Parameters:

transportUnitBK - The unique (physical) identifier

errorCode - The message to store with the TransportUnit

blockTransportUnit

@PostMapping(value="/v1/transport-units/block",
             params="bk")
void blockTransportUnit(@RequestParam("bk")
 String transportUnitBK)

Set the state of a TransportUnit to BLOCKED.

Parameters:

transportUnitBK - The unique (physical) identifier

unblockTransportUnit

@PostMapping(value="/v1/transport-units/available",
             params="bk")
void unblockTransportUnit(@RequestParam("bk")
 String transportUnitBK)

Set the state of a TransportUnit to AVAILABLE.

Parameters:

transportUnitBK - The unique (physical) identifier

qcTransportUnit

@PostMapping(value="/v1/transport-units/quality-check",
             params="bk")
void qcTransportUnit(@RequestParam("bk")
 String transportUnitBK)

Set the state of a TransportUnit to QUALITY_CHECK.

Parameters:

transportUnitBK - The unique (physical) identifier