Package org.openwms.wms.receiving.impl

Class ReceivingServiceImpl<T extends CaptureRequestVO>

java.lang.Object

org.openwms.wms.receiving.impl.ReceivingServiceImpl<T>

All Implemented Interfaces:

ReceivingService<T>

@Validated
@Service
class ReceivingServiceImpl<T extends CaptureRequestVO>
extends Object
implements ReceivingService<T>

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 org.springframework.plugin.core.PluginRegistry<ReceivingOrderCapturer<T>,CaptureRequestVO>	capturers
private static final org.slf4j.Logger	LOGGER
private final NextReceivingOrderRepository	nextReceivingOrderRepository
private final org.springframework.plugin.core.PluginRegistry<ReceivingOrderUpdater,ReceivingOrderUpdater.Type>	plugins
private final org.springframework.context.ApplicationEventPublisher	publisher
private final ReceivingOrderRepository	repository
private final ServiceProvider	serviceProvider
private final jakarta.validation.Validator	validator

Constructor Summary

Constructors

Constructor

Description

ReceivingServiceImpl(jakarta.validation.Validator validator, NextReceivingOrderRepository nextReceivingOrderRepository, ReceivingOrderRepository repository, org.springframework.plugin.core.PluginRegistry<ReceivingOrderUpdater,ReceivingOrderUpdater.Type> plugins, org.springframework.plugin.core.PluginRegistry<ReceivingOrderCapturer<T>,CaptureRequestVO> capturers, org.springframework.context.ApplicationEventPublisher publisher, ServiceProvider serviceProvider)

Method Summary

Modifier and Type	Method	Description
private void	assignOrderId(ReceivingOrder order)
@NotNull ReceivingOrder	cancelOrder(@NotBlank String pKey)	Cancel a ReceivingOrder.
@NotNull Optional<ReceivingOrder>	capture(@NotBlank String pKey, @NotNull @Valid List<T> requests)	Capturing on a ReceivingOrder means: Decrease one of the ReceivingOrderPositions by the received amount of the given Product Create physical PackagingUnit(s) from the received quantity
void	captureBlindReceipts(@NotNull List<T> requests)	Capture an unexpected receipt (aka Blind Receipt) that has no reference to a ReceivingOrder.
@NotNull ReceivingOrder	changeState(@NotBlank String pKey, @NotNull OrderState state)	Change the state of a ReceivingOrder.
@NotNull ReceivingOrder	complete(@NotBlank String pKey)	Complete a ReceivingOrder and all positions.
private ReceivingOrder	completeInternal(String pKey)
@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(@NotBlank String orderId)	Find and return a ReceivingOrder identified by its business key.
@NotNull ReceivingOrder	findByPKey(@NotBlank String pKey)	Find and return a ReceivingOrder identified by its synthetic persistent key.
private ReceivingOrder	getOrder(String pKey)
@NotNull ReceivingOrder	update(@NotBlank String pKey, @NotNull 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

validator

private final jakarta.validation.Validator validator

nextReceivingOrderRepository

private final NextReceivingOrderRepository nextReceivingOrderRepository

repository

private final ReceivingOrderRepository repository

plugins

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

capturers

private final org.springframework.plugin.core.PluginRegistry<ReceivingOrderCapturer<T extends CaptureRequestVO>,CaptureRequestVO> capturers

publisher

private final org.springframework.context.ApplicationEventPublisher publisher

serviceProvider

private final ServiceProvider serviceProvider

Constructor Details

ReceivingServiceImpl

ReceivingServiceImpl(jakarta.validation.Validator validator,
 NextReceivingOrderRepository nextReceivingOrderRepository,
 ReceivingOrderRepository repository,
 @Qualifier("plugins")
 org.springframework.plugin.core.PluginRegistry<ReceivingOrderUpdater,ReceivingOrderUpdater.Type> plugins,
 @Qualifier("capturers")
 org.springframework.plugin.core.PluginRegistry<ReceivingOrderCapturer<T>,CaptureRequestVO> capturers,
 org.springframework.context.ApplicationEventPublisher publisher,
 ServiceProvider serviceProvider)

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<T extends CaptureRequestVO>

Parameters:

order - The ReceivingOrder instance to create

Returns:

The saved instance

assignOrderId

private void assignOrderId(ReceivingOrder order)

capture

@Measured
@Transactional
@NotNull
public @NotNull Optional<ReceivingOrder> capture(@NotBlank
 @NotBlank String pKey,
 @NotNull @Valid
 @NotNull @Valid List<T> requests)

Capturing on a ReceivingOrder means:

• Decrease one of the ReceivingOrderPositions by the received amount of the given Product
• Create physical PackagingUnit(s) from the received quantity

Specified by:

capture in interface ReceivingService<T extends CaptureRequestVO>

Parameters:

pKey - The persistent key of the ReceivingOrder

requests - Contains all the capturing information according to the process in use

Returns:

The updated ReceivingOrder instance with updated positions

captureBlindReceipts

@Measured
public void captureBlindReceipts(@NotNull
 @NotNull List<T> requests)

Capture an unexpected receipt (aka Blind Receipt) that has no reference to a ReceivingOrder.

• Create physical PackagingUnit(s) from the received quantity

Specified by:

captureBlindReceipts in interface ReceivingService<T extends CaptureRequestVO>

Parameters:

requests - Contains all the capturing information according to the process in use

findByPKey

@Measured
@NotNull
public @NotNull ReceivingOrder findByPKey(@NotBlank
 @NotBlank String pKey)

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

Specified by:

findByPKey in interface ReceivingService<T extends CaptureRequestVO>

Parameters:

pKey - The synthetic persistent key

Returns:

The instance

findByOrderId

@Measured
public Optional<ReceivingOrder> findByOrderId(@NotBlank
 @NotBlank String orderId)

Find and return a ReceivingOrder identified by its business key.

Specified by:

findByOrderId in interface ReceivingService<T extends CaptureRequestVO>

Parameters:

orderId - The business key

Returns:

The order instance

update

@Measured
@Transactional
@NotNull
public @NotNull ReceivingOrder update(@NotBlank
 @NotBlank String pKey,
 @NotNull
 @NotNull ReceivingOrder receivingOrder)

Update an existing ReceivingOrder with the given data.

Specified by:

update in interface ReceivingService<T extends CaptureRequestVO>

Parameters:

pKey - The synthetic persistent key

receivingOrder - The representation to update

Returns:

The updated instance

complete

@Measured
@Transactional
@NotNull
public @NotNull ReceivingOrder complete(@NotBlank
 @NotBlank String pKey)

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

Specified by:

complete in interface ReceivingService<T extends CaptureRequestVO>

Parameters:

pKey - The synthetic persistent key

Returns:

The updated instance

completeInternal

private ReceivingOrder completeInternal(String pKey)

cancelOrder

@Measured
@Transactional
@NotNull
public @NotNull ReceivingOrder cancelOrder(@NotBlank
 @NotBlank String pKey)

Cancel a ReceivingOrder.

Specified by:

cancelOrder in interface ReceivingService<T extends CaptureRequestVO>

Parameters:

pKey - The synthetic persistent key

Returns:

The cancelled instance

changeState

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

Change the state of a ReceivingOrder.

Specified by:

changeState in interface ReceivingService<T extends CaptureRequestVO>

Parameters:

pKey - The synthetic persistent key

state - The new state

Returns:

The updated instance

getOrder

private ReceivingOrder getOrder(String pKey)

findAll

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

Find and return all existing ReceivingOrders.

Specified by:

findAll in interface ReceivingService<T extends CaptureRequestVO>

Returns:

A list of ReceivingOrders, never null