de.hybris.platform.warehousing.inventoryevent.service

Interface InventoryEventService

All Known Implementing Classes:

DefaultInventoryEventService

public interface InventoryEventService

The service related to the inventory events. The inventory events are used for ATP calculation and included allocation and cancellation events.

Method Summary

Modifier and Type	Method and Description
AllocationEventModel	createAllocationEvent(ConsignmentEntryModel consignmentEntry) Create an allocation event.
Collection<AllocationEventModel>	createAllocationEvents(ConsignmentModel consignment) Persists allocation events to account for the changes in stock quantities.
CancellationEventModel	createCancellationEvent(CancellationEventModel cancellationEventModel) Create an inventory cancellation event.
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.
AllocationEventModel	getAllocationEventForDeclineEntry(DeclineEntry declineEntry) Retrieves an AllocationEventModel for a DeclineEntry
Collection<AllocationEventModel>	getAllocationEventsForOrderEntry(OrderEntryModel orderEntry) Retrieves a collection of AllocationEventModel for an OrderEntryModel
void	reallocateAllocationEvent(DeclineEntry declineEntry, Long quantityToDecline) Delete or update the allocation event which has been created for a specific entry to decline

Method Detail

createAllocationEvents

Collection<AllocationEventModel> createAllocationEvents(ConsignmentModel consignment)

Persists allocation events to account for the changes in stock quantities.

Parameters:

consignment - the consignment where stock was allocated; never null

Returns:

a collection of AllocationEventModel; never null

createAllocationEvent

AllocationEventModel createAllocationEvent(ConsignmentEntryModel consignmentEntry)

Create an allocation event.

Parameters:

consignmentEntry - the consignment entry

Returns:

the allocation event; never null

createShrinkageEvent

ShrinkageEventModel createShrinkageEvent(ShrinkageEventModel shrinkageEventModel)

Create a shrinkage event.

Parameters:

shrinkageEventModel - the event containing information about the shrinkage

Returns:

the shrinkage event; never null

createWastageEvent

WastageEventModel createWastageEvent(WastageEventModel wastageEventModel)

Create a wastage event.

Parameters:

wastageEventModel - the event containing information about the wastage

Returns:

the wastage event; never null

createCancellationEvent

CancellationEventModel createCancellationEvent(CancellationEventModel cancellationEventModel)

Create an inventory cancellation event.

Parameters:

cancellationEventModel - the event containing information about the cancelled consignment entry

Returns:

the cancellation event; never null

getAllocationEventForDeclineEntry

AllocationEventModel getAllocationEventForDeclineEntry(DeclineEntry declineEntry)

Retrieves an AllocationEventModel for a DeclineEntry

Parameters:

declineEntry - the entry to decline

Returns:

the allocation event associated to the decline entry

getAllocationEventsForOrderEntry

Collection<AllocationEventModel> getAllocationEventsForOrderEntry(OrderEntryModel orderEntry)

Retrieves a collection of AllocationEventModel for an OrderEntryModel

Parameters:

orderEntry - the order entry for which to retrieve the events

Returns:

the collection of allocation events for the order entry

createIncreaseEvent

IncreaseEventModel createIncreaseEvent(IncreaseEventModel increaseEventModel)

Create an inventory increase event

Parameters:

increaseEventModel - the event containing information about the increase event model

Returns:

the increase event model

reallocateAllocationEvent

void reallocateAllocationEvent(DeclineEntry declineEntry,
                               Long quantityToDecline)

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

Parameters:

declineEntry - the entry to decline/reallocate

quantityToDecline - the quantity to decline/reallocate