InventoryEventService (hybris Commerce Suite 6.7.0.0)

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

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AllocationEventModel`	`createAllocationEvent(ConsignmentEntryModel consignmentEntry)` Deprecated. since 6.5 Please use `createAllocationEventsForConsignmentEntry(ConsignmentEntryModel)`
`java.util.Collection<AllocationEventModel>`	`createAllocationEvents(ConsignmentModel consignment)` Persists the `AllocationEventModel` to account for the changes in stock quantities.
`java.util.Collection<AllocationEventModel>`	`createAllocationEventsForConsignmentEntry(ConsignmentEntryModel consignmentEntry)` Create multiple `AllocationEventModel` that are required to fulfill the `ConsignmentEntryModel`
`CancellationEventModel`	`createCancellationEvent(CancellationEventModel cancellationEventModel)` Deprecated. since 6.5 Please use `createCancellationEvents(CancellationEventModel)`}
`java.util.Collection<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.
`AllocationEventModel`	`getAllocationEventForDeclineEntry(DeclineEntry declineEntry)` Deprecated. since 6.5 use `getAllocationEventsForConsignmentEntry(de.hybris.platform.ordersplitting.model.ConsignmentEntryModel)`
`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.
`<T extends InventoryEventModel> java.util.Collection<T>`	`getInventoryEventsForStockLevel(StockLevelModel stockLevel, java.lang.Class<T> eventClassType)` Retrieves a collection of `InventoryEventModel` for the `StockLevelModel`
`void`	`reallocateAllocationEvent(DeclineEntry declineEntry, java.lang.Long quantityToDecline)` Delete or update the allocation event which has been created for a specific entry to decline

- Method Detail
  - createAllocationEvents
```
java.util.Collection<AllocationEventModel> createAllocationEvents(ConsignmentModel consignment)
```
    Persists the AllocationEventModel to account for the changes in stock quantities.
    
    Parameters:
    
    consignment - the ConsignmentModel where stock was allocated; never null
    
    Returns:
    
    a collection of AllocationEventModel; never null
  - createAllocationEvent
```
@Deprecated
AllocationEventModel createAllocationEvent(ConsignmentEntryModel consignmentEntry)
```
    Deprecated. since 6.5 Please use createAllocationEventsForConsignmentEntry(ConsignmentEntryModel)
    
    Create an allocation event.
    
    Parameters:
    
    consignmentEntry - the ConsignmentEntryModel
    
    Returns:
    
    the allocation event; never null
  - createAllocationEventsForConsignmentEntry
```
java.util.Collection<AllocationEventModel> createAllocationEventsForConsignmentEntry(ConsignmentEntryModel consignmentEntry)
```
    Create multiple AllocationEventModel that are required to fulfill the ConsignmentEntryModel
    
    Parameters:
    
    consignmentEntry - the ConsignmentEntryModel
    
    Returns:
    
    a list of persisted AllocationEventModel
  - 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
```
@Deprecated
CancellationEventModel createCancellationEvent(CancellationEventModel cancellationEventModel)
```
    Deprecated. since 6.5 Please use createCancellationEvents(CancellationEventModel)}
    
    Create an inventory cancellation event.
    
    Parameters:
    
    cancellationEventModel - the event containing information about the cancelled consignment entry
    
    Returns:
    
    the cancellation event; never null
  - createCancellationEvents
```
java.util.Collection<CancellationEventModel> createCancellationEvents(CancellationEventModel cancellationEventModel)
```
    Create multiple CancellationEventModel
    
    Parameters:
    
    cancellationEventModel - the event containing information about the cancelled consignment entry
    
    Returns:
    
    the collection of persisted CancellationEventModel
  - getAllocationEventForDeclineEntry
```
@Deprecated
AllocationEventModel getAllocationEventForDeclineEntry(DeclineEntry declineEntry)
```
    Deprecated. since 6.5 use getAllocationEventsForConsignmentEntry(de.hybris.platform.ordersplitting.model.ConsignmentEntryModel)
    
    Retrieves an AllocationEventModel for a DeclineEntry
    
    Parameters:
    
    declineEntry - the entry to decline
    
    Returns:
    
    the AllocationEventModel associated to the DeclineEntry
  - getAllocationEventsForConsignmentEntry
```
java.util.Collection<AllocationEventModel> getAllocationEventsForConsignmentEntry(ConsignmentEntryModel consignmentEntry)
```
    Retrieves a collection of AllocationEventModel for a ConsignmentEntryModel
    
    Parameters:
    
    consignmentEntry - the ConsignmentEntryModel for which to retrieve the event
    
    Returns:
    
    the collection of AllocationEventModel associated to the consignment entry
  - getAllocationEventsForOrderEntry
```
java.util.Collection<AllocationEventModel> getAllocationEventsForOrderEntry(OrderEntryModel orderEntry)
```
    Retrieves a collection of AllocationEventModel for an OrderEntryModel
    
    Parameters:
    
    orderEntry - the OrderEntryModel for which to retrieve the events
    
    Returns:
    
    the collection of AllocationEventModel for the order entry
  - getInventoryEventsForStockLevel
```
<T extends InventoryEventModel> java.util.Collection<T> getInventoryEventsForStockLevel(StockLevelModel stockLevel,
                                                                                        java.lang.Class<T> eventClassType)
```
    Retrieves a collection of InventoryEventModel for the StockLevelModel
    
    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
  - createIncreaseEvent
```
IncreaseEventModel createIncreaseEvent(IncreaseEventModel increaseEventModel)
```
    Create an inventory increase event
    
    Parameters:
    
    increaseEventModel - the IncreaseEventModel containing information about the increase event model
    
    Returns:
    
    the increase event model
  - reallocateAllocationEvent
```
void reallocateAllocationEvent(DeclineEntry declineEntry,
                               java.lang.Long quantityToDecline)
```
    Delete or update the allocation event which has been created for a specific entry to decline
    
    Parameters:
    
    declineEntry - the DeclineEntry to decline/reallocate
    
    quantityToDecline - the quantity to decline/reallocate
  - getAllocationEventsForReallocation
```
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. Tries to map quantity to a stock level for adjustement
    
    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
  - getAllocationEventsForConsignment
```
java.util.Collection<AllocationEventModel> getAllocationEventsForConsignment(ConsignmentModel consignment)
```
    Retrieves a collection of AllocationEventModel for the given ConsignmentModel
    
    Parameters:
    
    consignment - the ConsignmentModel for which all allocation events will be returned
    
    Returns:
    
    the collection of AllocationEventModel

Interface InventoryEventService

Method Summary

Method Detail

createAllocationEvents

createAllocationEvent

createAllocationEventsForConsignmentEntry

createShrinkageEvent

createWastageEvent

createCancellationEvent

createCancellationEvents

getAllocationEventForDeclineEntry

getAllocationEventsForConsignmentEntry

getAllocationEventsForOrderEntry

getInventoryEventsForStockLevel

createIncreaseEvent

reallocateAllocationEvent

getAllocationEventsForReallocation

getAllocationEventsForConsignment