de.hybris.platform.stock.impl

Interface StockLevelDao

All Superinterfaces:

Dao

All Known Implementing Classes:

DefaultStockLevelDao

public interface StockLevelDao
extends Dao

The StockLevelModel DAO.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<StockLevelModel>	findAllStockLevels(java.lang.String productCode) Finds the stock levels of the specified product from all warehouses.
StockLevelModel	findStockLevel(java.lang.String productCode, WarehouseModel warehouse) Finds the stock level of the specified product at the specified warehouse.
java.util.Collection<StockLevelModel>	findStockLevels(java.lang.String productCode, java.util.Collection<WarehouseModel> warehouses) Finds all stock levels of the specified product in the specified warehouses.
java.util.Collection<StockLevelModel>	findStockLevels(java.lang.String productCode, java.util.Collection<WarehouseModel> warehouses, int preOrderQuantity)
java.lang.Integer	getAvailableQuantity(WarehouseModel warehouse, java.lang.String productCode)
java.lang.Integer	release(StockLevelModel stockLevel, int amount) Releases the stock level with the amount.
java.lang.Integer	reserve(StockLevelModel stockLevel, int amount) Reserves the stock level with the amount.
void	updateActualAmount(StockLevelModel stockLevel, int actualAmount) Updates the actual stock level with the actual amount.

Method Detail

findStockLevel

StockLevelModel findStockLevel(java.lang.String productCode,
                               WarehouseModel warehouse)

Finds the stock level of the specified product at the specified warehouse.

Parameters:

productCode - the product code

warehouse - warehouse of the product

Returns:

found stock level, and null if no such stock level can be found.

Throws:

java.lang.IllegalArgumentException - if either productCode or warehouse is null

findAllStockLevels

java.util.Collection<StockLevelModel> findAllStockLevels(java.lang.String productCode)

Finds the stock levels of the specified product from all warehouses.

Parameters:

productCode - the product code

Returns:

all found stock levels of product

Throws:

java.lang.IllegalArgumentException - if productCode is null

findStockLevels

java.util.Collection<StockLevelModel> findStockLevels(java.lang.String productCode,
                                                      java.util.Collection<WarehouseModel> warehouses)

Finds all stock levels of the specified product in the specified warehouses.

Parameters:

productCode - the product code

warehouses - the warehouses

Returns:

found stock levels of the product

Throws:

java.lang.IllegalArgumentException - if either productCode or warehouses is null

findStockLevels

java.util.Collection<StockLevelModel> findStockLevels(java.lang.String productCode,
                                                      java.util.Collection<WarehouseModel> warehouses,
                                                      int preOrderQuantity)

getAvailableQuantity

java.lang.Integer getAvailableQuantity(WarehouseModel warehouse,
                                       java.lang.String productCode)

reserve

java.lang.Integer reserve(StockLevelModel stockLevel,
                          int amount)

Reserves the stock level with the amount. NOTE: direct database reservation with jdbc query must be used.

Parameters:

stockLevel - the stock level to be reserved

amount - the amount of the reservation

Returns:

the actual stock level reserved amount after successful reservation, or NULL if reservation fails

release

java.lang.Integer release(StockLevelModel stockLevel,
                          int amount)

Releases the stock level with the amount. NOTE: direct database reservation with jdbc query must be used.

Parameters:

stockLevel - the stock level to be released

amount - the amount of the release

Returns:

the actual stock level reserved amount after successful release, or NULL if release fails

updateActualAmount

void updateActualAmount(StockLevelModel stockLevel,
                        int actualAmount)

Updates the actual stock level with the actual amount. NOTE: direct database reservation with jdbc query must be used.

Parameters:

stockLevel - the stock level to be updated

actualAmount - the actual amount of the stock level