Package org.openwms.tms.impl

Class TransportationServiceImpl

java.lang.Object

org.openwms.tms.impl.TransportationServiceImpl

All Implemented Interfaces:

TransportationService<TransportOrder>

@TxService
class TransportationServiceImpl
extends Object
implements TransportationService<TransportOrder>

A TransportationServiceImpl is a Spring managed transactional service.

Author:

Heiko Scherrer

Field Summary

Fields

Modifier and Type	Field	Description
private final org.springframework.context.ApplicationContext	ctx
private static final org.slf4j.Logger	LOGGER
private final TransportOrderRepository<TransportOrder,Long>	repository
private final StateManager	stateManager
private final List<TargetResolver<org.openwms.common.location.api.TargetVO>>	targetResolvers
private final org.ameba.i18n.Translator	translator
private final List<UpdateFunction>	updateFunctions

Constructor Summary

Constructors

Constructor	Description
TransportationServiceImpl(org.ameba.i18n.Translator translator, TransportOrderRepository<TransportOrder,Long> repository, org.springframework.context.ApplicationContext ctx, StateManager stateManager, List<UpdateFunction> updateFunctions, List<TargetResolver<org.openwms.common.location.api.TargetVO>> targetResolvers)

Method Summary

Modifier and Type	Method	Description
Collection<Message>	change(String barcode, TransportOrderState currentState, TransportOrderState targetState, Message message)	Request a state change for all TransportOrders for the TransportUnit with the given barcode.
Collection<String>	change(TransportOrderState state, Collection<String> pKeys)	Try to turn a list of TransportOrders into the given state.
TransportOrder	create(String barcode, String target, String priority)	Create a new TransportOrder with the given target.
private TransportOrder	findBy(String pKey)
List<TransportOrder>	findBy(String barcode, String... states)	FInd all TransportOrders for a TransportUnit in the given states.
@NotNull TransportOrder	findByPKey(@NotBlank String pKey)	Find and return the TransportOrder identified by the persisted key pKey.
int	getNoTransportOrdersToTarget(String target, String... states)	Returns the number of TransportOrders that have the target as target and are in one of the states.
TransportOrder	update(TransportOrder transportOrder)	Modifies an existing TransportOrder according to the argument passed as TransportOrder.

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

translator

private final org.ameba.i18n.Translator translator

repository

private final TransportOrderRepository<TransportOrder,Long> repository

ctx

private final org.springframework.context.ApplicationContext ctx

stateManager

private final StateManager stateManager

updateFunctions

private final List<UpdateFunction> updateFunctions

targetResolvers

private final List<TargetResolver<org.openwms.common.location.api.TargetVO>> targetResolvers

Constructor Details

TransportationServiceImpl

TransportationServiceImpl(org.ameba.i18n.Translator translator,
 TransportOrderRepository<TransportOrder,Long> repository,
 org.springframework.context.ApplicationContext ctx,
 StateManager stateManager,
 @Autowired(required=false)
 List<UpdateFunction> updateFunctions,
 @Autowired(required=false)
 List<TargetResolver<org.openwms.common.location.api.TargetVO>> targetResolvers)

Method Details

findBy

@Measured
public List<TransportOrder> findBy(String barcode,
 String... states)

FInd all TransportOrders for a TransportUnit in the given states.

Specified by:

findBy in interface TransportationService<TransportOrder>

Parameters:

barcode - The Barcode of the TransportUnit

states - A set of TransportOrder states

Returns:

A List of all TransportOrders, never null

findByPKey

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

Find and return the TransportOrder identified by the persisted key pKey.

Specified by:

findByPKey in interface TransportationService<TransportOrder>

Parameters:

pKey - The persisted key

Returns:

An TransportOrder instance

findBy

private TransportOrder findBy(String pKey)

getNoTransportOrdersToTarget

@Measured
public int getNoTransportOrdersToTarget(String target,
 String... states)

Returns the number of TransportOrders that have the target as target and are in one of the states.

Specified by:

getNoTransportOrdersToTarget in interface TransportationService<TransportOrder>

Parameters:

target - The target place to search TransportOrders for

states - An array of TransportOrder states to filter TransportOrders for

Returns:

Number of all TransportOrders in one of the states that are on the way to the target

create

@Transactional(propagation=REQUIRES_NEW,
               noRollbackFor=StateChangeException.class)
@Measured
public TransportOrder create(String barcode,
 String target,
 String priority)

Create a new TransportOrder with the given target.

Checks that all necessary data to create a TransportOrder is given, does not do any logical checks, whether a target is blocked or a TransportOrder for the TransportUnit exist.

Specified by:

create in interface TransportationService<TransportOrder>

Parameters:

barcode - The ID of the TransportUnit to move

target - The target of the TransportOrder to move to

priority - A PriorityLevel of the new TransportOrder

Returns:

The newly created TransportOrder

Throws:

org.ameba.exception.NotFoundException - when the barcode is null or no transportunit with barcode can be found or no target can be found.

update

@Measured
public TransportOrder update(TransportOrder transportOrder)

Modifies an existing TransportOrder according to the argument passed as TransportOrder.

Specified by:

update in interface TransportationService<TransportOrder>

Parameters:

transportOrder - Stores the ID of the TransportOrder to change as well as the state to change

Returns:

The modified instance

change

@Measured
public Collection<String> change(TransportOrderState state,
 Collection<String> pKeys)

Try to turn a list of TransportOrders into the given state.

Specified by:

change in interface TransportationService<TransportOrder>

Parameters:

state - The state to change all orders to

pKeys - The persisted keys of TransportOrders

Returns:

A list of persisted keys of TransportOrders that have not been changed

change

@Measured
public Collection<Message> change(String barcode,
 TransportOrderState currentState,
 TransportOrderState targetState,
 Message message)

Request a state change for all TransportOrders for the TransportUnit with the given barcode.

Specified by:

change in interface TransportationService<TransportOrder>

Parameters:

barcode - The ID of the TransportUnit to move

currentState - The state of TransportOrders to change

targetState - The state to change all orders to

message - A messages attached to the changed TransportOrder, may be null

Returns:

A list of Messages according to the TransportOrders that have not been changed