org.openwms.common.service
Interface TransportUnitService<T extends TransportUnit>

Type Parameters:
T - Any kind of TransportUnit
All Superinterfaces:
EntityService<TransportUnit>
All Known Implementing Classes:
TransportUnitServiceImpl

public interface TransportUnitService<T extends TransportUnit>
extends EntityService<TransportUnit>

A TransportService is an extension of the EntityService interface about some useful methods regarding the general handling with TransportUnits.

Since:
0.1
Version:
$Revision: 1409 $
Author:
Heiko Scherrer
See Also:
EntityService

Method Summary
 T createTransportUnit(Barcode barcode, TransportUnitType transportUnitType, LocationPK actualLocation)
          Create a new TransportUnit with the type TransportUnitType placed on an initial Location.
 TransportUnitType createTransportUnitType(TransportUnitType transportUnitType)
          Create a new TransportUnitType.
 void deleteTransportUnits(List<T> transportUnits)
          Delete already persisted TransportUnits from the persistence storage.
 void deleteTransportUnitTypes(List<TransportUnitType> transportUnitType)
          Delete already persisted TransportUnitType instances.
 List<T> getAllTransportUnits()
          Returns an unsorted List of all TransportUnits.
 List<TransportUnitType> getAllTransportUnitTypes()
          Returns an unsorted List of all TransportUnitTypes.
 List<Rule> loadRules(String transportUnitType)
          Return a List of all Rules that belong to this TransportUnitType type.
 void moveTransportUnit(Barcode barcode, LocationPK targetLocationPK)
          Move a TransportUnit identified by its Barcode to the given target Location identified by the LocationPK.
 TransportUnitType saveTransportUnitType(TransportUnitType transportUnitType)
          Save an already persisted instance of TransportUnitType.
 TransportUnitType updateRules(String type, List<LocationType> newAssigned, List<LocationType> newNotAssigned)
          Update the List of TypePlacingRules for the given TransportUnitType type.
 
Methods inherited from interface org.openwms.core.service.EntityService
add, findAll, remove, save
 

Method Detail

createTransportUnit

T createTransportUnit(Barcode barcode,
                      TransportUnitType transportUnitType,
                      LocationPK actualLocation)
Create a new TransportUnit with the type TransportUnitType placed on an initial Location. The new TransportUnit has the given Barcode as identifier.

Parameters:
barcode - Barcode of the new TransportUnit
transportUnitType - The type of the new TransportUnit
actualLocation - The Location where the TransportUnit is placed on
Returns:
The new created TransportUnit instance

moveTransportUnit

void moveTransportUnit(Barcode barcode,
                       LocationPK targetLocationPK)
Move a TransportUnit identified by its Barcode to the given target Location identified by the LocationPK.

Parameters:
barcode - Barcode of the TransportUnit to move
targetLocationPK - Unique identifier of the target Location

deleteTransportUnits

void deleteTransportUnits(List<T> transportUnits)
Delete already persisted TransportUnits from the persistence storage. It is not allowed in all cases to delete a TransportUnit , potentially an active TransportOrder exists or Inventory is still linked with the transportUnit.

Parameters:
transportUnits - The collection of TransportUnits to delete

getAllTransportUnits

List<T> getAllTransportUnits()
Returns an unsorted List of all TransportUnits.

Returns:
A List of all TransportUnits

getAllTransportUnitTypes

List<TransportUnitType> getAllTransportUnitTypes()
Returns an unsorted List of all TransportUnitTypes.

Returns:
A list of all TransportUnitTypes

createTransportUnitType

TransportUnitType createTransportUnitType(TransportUnitType transportUnitType)
Create a new TransportUnitType.

Parameters:
transportUnitType - The type to be created
Returns:
The new created TransportUnitType instance.

deleteTransportUnitTypes

void deleteTransportUnitTypes(List<TransportUnitType> transportUnitType)
Delete already persisted TransportUnitType instances.

Parameters:
transportUnitType - A list of all instances to be deleted.

saveTransportUnitType

TransportUnitType saveTransportUnitType(TransportUnitType transportUnitType)
Save an already persisted instance of TransportUnitType.

Parameters:
transportUnitType - The instance to be updated
Returns:
The updated instance

updateRules

TransportUnitType updateRules(String type,
                              List<LocationType> newAssigned,
                              List<LocationType> newNotAssigned)
Update the List of TypePlacingRules for the given TransportUnitType type.

Parameters:
type - The TransportUnitType to update.
newAssigned - A new List of LocationTypes that are allowed for the TransportUnitType.
newNotAssigned - A List of LocationTypes. All TypePlacingRules will be removed which have one of this LocationTypes and the requested TransportUnitType type.
Returns:
The updated TransportUnitType.

loadRules

List<Rule> loadRules(String transportUnitType)
Return a List of all Rules that belong to this TransportUnitType type.

Parameters:
transportUnitType - The TransportUnitType to search for.
Returns:
The requested List or null if no Rule was found.


Copyright © 2005-2011 openwms.org. All Rights Reserved.