Package de.hybris.platform.warehousing.inventoryevent.service.impl

Class DefaultInventoryEventService

java.lang.Object

de.hybris.platform.warehousing.inventoryevent.service.impl.DefaultInventoryEventService

All Implemented Interfaces:

InventoryEventService

public class DefaultInventoryEventService
extends java.lang.Object
implements InventoryEventService

The default implementation of InventoryEventService

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor	Description
DefaultInventoryEventService()

Method Summary

Modifier and Type	Method	Description
protected long	addToAllocationMap(java.util.Map<AllocationEventModel,java.lang.Long> allocationMap, AllocationEventModel allocationEvent, long quantityLeft, java.lang.Long quantityAvailable)	Adds AllocationEventModel and quantity to the Map depending on the quantity left and quantity available.
java.util.Collection<AllocationEventModel>	createAllocationEvents(ConsignmentModel consignment)	Persists the AllocationEventModel to account for the changes in stock quantities.
java.util.List<AllocationEventModel>	createAllocationEventsForConsignmentEntry(ConsignmentEntryModel consignmentEntry)	Create multiple AllocationEventModel that are required to fulfill the ConsignmentEntryModel
java.util.List<CancellationEventModel>	createCancellationEvents(CancellationEventModel cancellationEventModel)	Create multiple CancellationEventModel
IncreaseEventModel	createIncreaseEvent(IncreaseEventModel increaseEventModel)	Create an inventory increase event
ShrinkageEventModel	createShrinkageEvent(ShrinkageEventModel shrinkageEventModel)	Create a shrinkage event.
WastageEventModel	createWastageEvent(WastageEventModel wastageEventModel)	Create a wastage event.
protected void	finalizeStockMap(java.util.Map<AllocationEventModel,java.lang.Long> allocationMap, long quantityLeft)	If there's still any quantity left, the first entry of the passed Stock map will be increased by this amount.
java.util.Collection<AllocationEventModel>	getAllocationEventsForConsignment(ConsignmentModel consignment)	Retrieves a collection of AllocationEventModel for the given ConsignmentModel
java.util.Collection<AllocationEventModel>	getAllocationEventsForConsignmentEntry(ConsignmentEntryModel consignmentEntry)	Retrieves a collection of AllocationEventModel for a ConsignmentEntryModel
java.util.Collection<AllocationEventModel>	getAllocationEventsForOrderEntry(OrderEntryModel orderEntry)	Retrieves a collection of AllocationEventModel for an OrderEntryModel
java.util.Map<AllocationEventModel,java.lang.Long>	getAllocationEventsForReallocation(java.util.Collection<AllocationEventModel> allocationEvents, java.lang.Long quantityToDecline)	Extracts the StockLevelModel of AllocationEventModel and sorts them by quantity.
protected InventoryEventDao	getInventoryEventDao()
<T extends InventoryEventModel> java.util.Collection<T>	getInventoryEventsForStockLevel(StockLevelModel stockLevel, java.lang.Class<T> eventClassType)	Retrieves a collection of InventoryEventModel for the StockLevelModel
protected ModelService	getModelService()
protected StockLevelSelectionStrategy	getStockLevelSelectionStrategy()
protected StockService	getStockService()
protected TimeService	getTimeService()
void	reallocateAllocationEvent(DeclineEntry declineEntry, java.lang.Long quantityToDecline)	Delete or update the allocation event which has been created for a specific entry to decline
void	setInventoryEventDao(InventoryEventDao inventoryEventDao)
void	setModelService(ModelService modelService)
void	setStockLevelSelectionStrategy(StockLevelSelectionStrategy stockLevelSelectionStrategy)
void	setStockService(StockService stockService)
void	setTimeService(TimeService timeService)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

Constructor Detail

DefaultInventoryEventService

public DefaultInventoryEventService()

Method Detail

getAllocationEventsForConsignmentEntry

public java.util.Collection<AllocationEventModel> getAllocationEventsForConsignmentEntry(ConsignmentEntryModel consignmentEntry)

Description copied from interface: InventoryEventService

Retrieves a collection of AllocationEventModel for a ConsignmentEntryModel

Specified by:

getAllocationEventsForConsignmentEntry in interface InventoryEventService

Parameters:

consignmentEntry - the ConsignmentEntryModel for which to retrieve the event

Returns:

the collection of AllocationEventModel associated to the consignment entry

getAllocationEventsForOrderEntry

public java.util.Collection<AllocationEventModel> getAllocationEventsForOrderEntry(OrderEntryModel orderEntry)

Description copied from interface: InventoryEventService

Retrieves a collection of AllocationEventModel for an OrderEntryModel

Specified by:

getAllocationEventsForOrderEntry in interface InventoryEventService

Parameters:

orderEntry - the OrderEntryModel for which to retrieve the events

Returns:

the collection of AllocationEventModel for the order entry

getInventoryEventsForStockLevel

public <T extends InventoryEventModel> java.util.Collection<T> getInventoryEventsForStockLevel(StockLevelModel stockLevel,
                                                                                               java.lang.Class<T> eventClassType)

Description copied from interface: InventoryEventService

Retrieves a collection of InventoryEventModel for the StockLevelModel

Specified by:

getInventoryEventsForStockLevel in interface InventoryEventService

Parameters:

stockLevel - the StockLevelModel for which the events need to be extracted

eventClassType - the class representing the type of inventory event

Returns:

the collection of inventory events for the given StockLevelModel

createAllocationEvents

public java.util.Collection<AllocationEventModel> createAllocationEvents(ConsignmentModel consignment)

Description copied from interface: InventoryEventService

Persists the AllocationEventModel to account for the changes in stock quantities.

Specified by:

createAllocationEvents in interface InventoryEventService

Parameters:

consignment - the ConsignmentModel where stock was allocated; never null

Returns:

a collection of AllocationEventModel; never null

createAllocationEventsForConsignmentEntry

public java.util.List<AllocationEventModel> createAllocationEventsForConsignmentEntry(ConsignmentEntryModel consignmentEntry)

Description copied from interface: InventoryEventService

Create multiple AllocationEventModel that are required to fulfill the ConsignmentEntryModel

Specified by:

createAllocationEventsForConsignmentEntry in interface InventoryEventService

Parameters:

consignmentEntry - the ConsignmentEntryModel

Returns:

a list of persisted AllocationEventModel

createShrinkageEvent

public ShrinkageEventModel createShrinkageEvent(ShrinkageEventModel shrinkageEventModel)

Description copied from interface: InventoryEventService

Create a shrinkage event.

Specified by:

createShrinkageEvent in interface InventoryEventService

Parameters:

shrinkageEventModel - the event containing information about the shrinkage

Returns:

the shrinkage event; never null

createWastageEvent

public WastageEventModel createWastageEvent(WastageEventModel wastageEventModel)

Description copied from interface: InventoryEventService

Create a wastage event.

Specified by:

createWastageEvent in interface InventoryEventService

Parameters:

wastageEventModel - the event containing information about the wastage

Returns:

the wastage event; never null

createCancellationEvents

public java.util.List<CancellationEventModel> createCancellationEvents(CancellationEventModel cancellationEventModel)

Description copied from interface: InventoryEventService

Create multiple CancellationEventModel

Specified by:

createCancellationEvents in interface InventoryEventService

Parameters:

cancellationEventModel - the event containing information about the cancelled consignment entry

Returns:

the collection of persisted CancellationEventModel

createIncreaseEvent

public IncreaseEventModel createIncreaseEvent(IncreaseEventModel increaseEventModel)

Description copied from interface: InventoryEventService

Create an inventory increase event

Specified by:

createIncreaseEvent in interface InventoryEventService

Parameters:

increaseEventModel - the IncreaseEventModel containing information about the increase event model

Returns:

the increase event model

reallocateAllocationEvent

public void reallocateAllocationEvent(DeclineEntry declineEntry,
                                      java.lang.Long quantityToDecline)

Description copied from interface: InventoryEventService

Delete or update the allocation event which has been created for a specific entry to decline

Specified by:

reallocateAllocationEvent in interface InventoryEventService

Parameters:

declineEntry - the DeclineEntry to decline/reallocate

quantityToDecline - the quantity to decline/reallocate

getAllocationEventsForReallocation

public java.util.Map<AllocationEventModel,java.lang.Long> getAllocationEventsForReallocation(java.util.Collection<AllocationEventModel> allocationEvents,
                                                                                                   java.lang.Long quantityToDecline)

Description copied from interface: InventoryEventService

Extracts the StockLevelModel of AllocationEventModel and sorts them by quantity. Tries to map quantity to a stock level for adjustement

Specified by:

getAllocationEventsForReallocation in interface InventoryEventService

Parameters:

allocationEvents - collection of allocation events

quantityToDecline - total quantity to be adjusted

Returns:

a map of AllocationEventModel with the quantity to adjust for this stock level

addToAllocationMap

protected long addToAllocationMap(java.util.Map<AllocationEventModel,java.lang.Long> allocationMap,
                                  AllocationEventModel allocationEvent,
                                  long quantityLeft,
                                  java.lang.Long quantityAvailable)

Adds AllocationEventModel and quantity to the Map depending on the quantity left and quantity available. Returns the quantity that was not able to be fulfilled by the passed AllocationEventModel

Parameters:

allocationMap - the AllocationEventModel map to append the stock passed

allocationEvent - the AllocationEventModel

quantityLeft - the quantity left to be added to the map

quantityAvailable - the quantity available in the passed InventoryEventModel.getStockLevel()

Returns:

the quantity left.

finalizeStockMap

protected void finalizeStockMap(java.util.Map<AllocationEventModel,java.lang.Long> allocationMap,
                                long quantityLeft)

If there's still any quantity left, the first entry of the passed Stock map will be increased by this amount.

Parameters:

allocationMap - the AllocationEventModel to quantity map

quantityLeft - the quantity left to fulfill

getAllocationEventsForConsignment

public java.util.Collection<AllocationEventModel> getAllocationEventsForConsignment(ConsignmentModel consignment)

Description copied from interface: InventoryEventService

Retrieves a collection of AllocationEventModel for the given ConsignmentModel

Specified by:

getAllocationEventsForConsignment in interface InventoryEventService

Parameters:

consignment - the ConsignmentModel for which all allocation events will be returned

Returns:

the collection of AllocationEventModel

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getInventoryEventDao

protected InventoryEventDao getInventoryEventDao()

setInventoryEventDao

public void setInventoryEventDao(InventoryEventDao inventoryEventDao)

getStockLevelSelectionStrategy

protected StockLevelSelectionStrategy getStockLevelSelectionStrategy()

setStockLevelSelectionStrategy

public void setStockLevelSelectionStrategy(StockLevelSelectionStrategy stockLevelSelectionStrategy)

getStockService

protected StockService getStockService()

setStockService

public void setStockService(StockService stockService)

getTimeService

protected TimeService getTimeService()

setTimeService

public void setTimeService(TimeService timeService)