Package org.openwms.wms.receiving.impl

Class ReceivingServiceImpl

java.lang.Object

org.openwms.wms.receiving.impl.ReceivingServiceImpl

All Implemented Interfaces:

ReceivingService

@Validated
@TxService
class ReceivingServiceImpl
extends Object
implements ReceivingService

A ReceivingServiceImpl is a Spring managed transactional Services that deals with ReceivingOrders.

Author:

Heiko Scherrer

Field Summary

Fields

Modifier and Type	Field	Description
private final AsyncPackagingUnitApi	asyncPackagingUnitApi
private static final org.slf4j.Logger	LOGGER
private final NextReceivingOrderRepository	nextReceivingOrderRepository
private final boolean	overbookingAllowed
private final PackagingUnitApi	packagingUnitApi
private final org.springframework.plugin.core.PluginRegistry<ReceivingOrderUpdater,ReceivingOrderUpdater.Type>	plugins
private final ProductService	productService
private final org.springframework.context.ApplicationEventPublisher	publisher
private final ReceivingMapper	receivingMapper
private final ReceivingOrderRepository	repository
private final org.ameba.i18n.Translator	translator
private final TransportUnitApi	transportUnitApi

Constructor Summary

Constructors

Constructor

Description

ReceivingServiceImpl(boolean overbookingAllowed, org.ameba.i18n.Translator translator, ReceivingMapper receivingMapper, NextReceivingOrderRepository nextReceivingOrderRepository, ReceivingOrderRepository repository, ProductService productService, org.springframework.plugin.core.PluginRegistry<ReceivingOrderUpdater,ReceivingOrderUpdater.Type> plugins, org.springframework.context.ApplicationEventPublisher publisher, AsyncPackagingUnitApi asyncPackagingUnitApi, PackagingUnitApi packagingUnitApi, TransportUnitApi transportUnitApi)

Method Summary

Modifier and Type	Method	Description
ReceivingOrder	cancelOrder(@NotEmpty String pKey)	Cancel a ReceivingOrder.
private ReceivingOrder	capture(@NotEmpty String pKey, @NotEmpty String transportUnitId, @NotEmpty String loadUnitPosition, @NotEmpty String loadUnitType, @NotNull org.openwms.core.units.api.Measurable quantityReceived, CaptureDetailsVO details, @NotEmpty String sku)
@NotNull ReceivingOrderVO	capture(@NotEmpty String pKey, @NotEmpty String loadUnitType, @NotNull @Valid List<CaptureRequestVO> requests)	Decrease one of the ReceivingOrderPositions by the received amount of the given Product and book the received article to the TransportUnit identified by the transportUnitId.
private ReceivingOrder	capture(String pKey, String expectedTransportUnitBK, String actualLocationErpCode)
private ReceivingOrder	captureQuantityOnLocation(String pKey, String erpCode, org.openwms.core.units.api.Measurable quantityReceived, CaptureDetailsVO details, String sku)
ReceivingOrder	changeState(@NotEmpty String pKey, @NotNull OrderState state)	Change the state of a ReceivingOrder.
ReceivingOrderVO	complete(@NotEmpty String pKey)	Complete a ReceivingOrder and all positions.
@NotNull ReceivingOrder	createOrder(@NotNull ReceivingOrder order)	Create a ReceivingOrder with containing ReceivingOrderPosition.
@NotNull List<ReceivingOrder>	findAll()	Find and return all existing ReceivingOrders.
Optional<ReceivingOrder>	findByOrderId(@NotEmpty String orderId)	Find and return a ReceivingOrder identified by its business key.
@NotNull ReceivingOrder	findByPKey(@NotEmpty String pKey)	Find and return a ReceivingOrder identified by its synthetic persistent key.
private ReceivingOrder	getOrder(@NotEmpty String pKey)
private Product	getProduct(String sku)
ReceivingOrder	update(String pKey, ReceivingOrder receivingOrder)	Update an existing ReceivingOrder with the given data.

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

overbookingAllowed

private final boolean overbookingAllowed

translator

private final org.ameba.i18n.Translator translator

receivingMapper

private final ReceivingMapper receivingMapper

nextReceivingOrderRepository

private final NextReceivingOrderRepository nextReceivingOrderRepository

repository

private final ReceivingOrderRepository repository

productService

private final ProductService productService

plugins

private final org.springframework.plugin.core.PluginRegistry<ReceivingOrderUpdater,ReceivingOrderUpdater.Type> plugins

publisher

private final org.springframework.context.ApplicationEventPublisher publisher

asyncPackagingUnitApi

private final AsyncPackagingUnitApi asyncPackagingUnitApi

packagingUnitApi

private final PackagingUnitApi packagingUnitApi

transportUnitApi

private final TransportUnitApi transportUnitApi

Constructor Details

ReceivingServiceImpl

ReceivingServiceImpl(@Value("${owms.receiving.unexpected-receipts-allowed:true}")
 boolean overbookingAllowed,
 org.ameba.i18n.Translator translator,
 ReceivingMapper receivingMapper,
 NextReceivingOrderRepository nextReceivingOrderRepository,
 ReceivingOrderRepository repository,
 ProductService productService,
 org.springframework.plugin.core.PluginRegistry<ReceivingOrderUpdater,ReceivingOrderUpdater.Type> plugins,
 org.springframework.context.ApplicationEventPublisher publisher,
 AsyncPackagingUnitApi asyncPackagingUnitApi,
 PackagingUnitApi packagingUnitApi,
 TransportUnitApi transportUnitApi)

Method Details

createOrder

@Measured
@NotNull
public @NotNull ReceivingOrder createOrder(@NotNull
 @NotNull ReceivingOrder order)

Create a ReceivingOrder with containing ReceivingOrderPosition.

Specified by:

createOrder in interface ReceivingService

Parameters:

order - The ReceivingOrder instance to create

Returns:

The saved instance

getProduct

private Product getProduct(String sku)

capture

private ReceivingOrder capture(@NotEmpty
 @NotEmpty String pKey,
 @NotEmpty
 @NotEmpty String transportUnitId,
 @NotEmpty
 @NotEmpty String loadUnitPosition,
 @NotEmpty
 @NotEmpty String loadUnitType,
 @NotNull
 @NotNull org.openwms.core.units.api.Measurable quantityReceived,
 CaptureDetailsVO details,
 @NotEmpty
 @NotEmpty String sku)

captureQuantityOnLocation

private ReceivingOrder captureQuantityOnLocation(String pKey,
 String erpCode,
 org.openwms.core.units.api.Measurable quantityReceived,
 CaptureDetailsVO details,
 String sku)

capture

@Measured
@NotNull
public @NotNull ReceivingOrderVO capture(@NotEmpty
 @NotEmpty String pKey,
 @NotEmpty
 @NotEmpty String loadUnitType,
 @NotNull @Valid
 @NotNull @Valid List<CaptureRequestVO> requests)

Decrease one of the ReceivingOrderPositions by the received amount of the given Product and book the received article to the TransportUnit identified by the transportUnitId.

Specified by:

capture in interface ReceivingService

Parameters:

pKey - The persistent key of the ReceivingOrder

loadUnitType - In case the LoadUnit is created this is type for the LoadUnit

requests - all captures to process

Returns:

The updated ReceivingOrder instance with updated positions

capture

private ReceivingOrder capture(String pKey,
 String expectedTransportUnitBK,
 String actualLocationErpCode)

findByPKey

@Transactional(readOnly=true)
@Measured
@NotNull
public @NotNull ReceivingOrder findByPKey(@NotEmpty
 @NotEmpty String pKey)

Find and return a ReceivingOrder identified by its synthetic persistent key.

Specified by:

findByPKey in interface ReceivingService

Parameters:

pKey - The synthetic persistent key

Returns:

The instance

findByOrderId

@Measured
@Transactional(readOnly=true)
public Optional<ReceivingOrder> findByOrderId(@NotEmpty
 @NotEmpty String orderId)

Find and return a ReceivingOrder identified by its business key.

Specified by:

findByOrderId in interface ReceivingService

Parameters:

orderId - The business key

Returns:

The order instance

update

@Measured
public ReceivingOrder update(String pKey,
 ReceivingOrder receivingOrder)

Update an existing ReceivingOrder with the given data.

Specified by:

update in interface ReceivingService

Parameters:

pKey - The synthetic persistent key

receivingOrder - The representation to update

Returns:

The updated instance

complete

@Measured
public ReceivingOrderVO complete(@NotEmpty
 @NotEmpty String pKey)

Complete a ReceivingOrder and all positions. Satisfy quantities and set the state to COMPLETED.

Specified by:

complete in interface ReceivingService

Parameters:

pKey - The synthetic persistent key

Returns:

The updated instance

cancelOrder

@Measured
public ReceivingOrder cancelOrder(@NotEmpty
 @NotEmpty String pKey)

Cancel a ReceivingOrder.

Specified by:

cancelOrder in interface ReceivingService

Parameters:

pKey - The synthetic persistent key

Returns:

The cancelled instance

changeState

@Measured
public ReceivingOrder changeState(@NotEmpty
 @NotEmpty String pKey,
 @NotNull
 @NotNull OrderState state)

Change the state of a ReceivingOrder.

Specified by:

changeState in interface ReceivingService

Parameters:

pKey - The synthetic persistent key

state - The new state

Returns:

The updated instance

getOrder

private ReceivingOrder getOrder(@NotEmpty
 @NotEmpty String pKey)

findAll

@Measured
@NotNull
public @NotNull List<ReceivingOrder> findAll()

Find and return all existing ReceivingOrders.

Specified by:

findAll in interface ReceivingService

Returns:

A list of ReceivingOrders, never null