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 static org.slf4j.Logger	LOGGER
private boolean	overbookingAllowed
private PackagingUnitApi	packagingUnitApi
private org.springframework.context.ApplicationEventPublisher	publisher
private ReceivingOrderRepository	repository
private ProductService	service
private org.ameba.i18n.Translator	translator

Constructor Summary

Constructors

Constructor	Description
ReceivingServiceImpl(boolean overbookingAllowed, org.ameba.i18n.Translator translator, ReceivingOrderRepository repository, ProductService service, org.springframework.context.ApplicationEventPublisher publisher, PackagingUnitApi packagingUnitApi)

Method Summary

Modifier and Type	Method	Description
void	cancelOrder(@NotEmpty String pKey)	Cancel a ReceivingOrder.
@NotNull ReceivingOrder	capture(@NotEmpty String pKey, @NotEmpty String transportUnitId, @NotEmpty String loadUnitPosition, @NotEmpty String loadUnitType, @NotNull org.openwms.core.units.api.Measurable quantityReceived, CaptureDetailsVO details, @NotNull @Valid Product product)	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.
@NotNull ReceivingOrder	createOrder(@NotNull @Valid 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.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

overbookingAllowed

private final boolean overbookingAllowed

translator

private final org.ameba.i18n.Translator translator

repository

private final ReceivingOrderRepository repository

service

private final ProductService service

publisher

private final org.springframework.context.ApplicationEventPublisher publisher

packagingUnitApi

private final PackagingUnitApi packagingUnitApi

Constructor Detail

ReceivingServiceImpl

ReceivingServiceImpl(@Value("${owms.receiving.unexpected-receipts-allowed:true}")
                     boolean overbookingAllowed,
                     org.ameba.i18n.Translator translator,
                     ReceivingOrderRepository repository,
                     ProductService service,
                     org.springframework.context.ApplicationEventPublisher publisher,
                     PackagingUnitApi packagingUnitApi)

Method Detail

createOrder

@Measured
@NotNull
public @NotNull ReceivingOrder createOrder(@NotNull @Valid
                                           @NotNull @Valid 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

capture

@Measured
@NotNull
public @NotNull 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,
                                       @NotNull @Valid
                                       @NotNull @Valid Product product)

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

transportUnitId - The identifier of the TransportUnit to book the Product to

loadUnitPosition - The position of the LoadUnit

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

quantityReceived - The received quantity

product - The received Product

Returns:

The updated ReceivingOrder instance with updated positions

findByPKey

@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
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

cancelOrder

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

Cancel a ReceivingOrder.

Specified by:

cancelOrder in interface ReceivingService

Parameters:

pKey - The synthetic persistent key

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