pb138.service.facades

Interface ItemFacade

All Known Implementing Classes:

ItemFacadeImpl

public interface ItemFacade

For creating item from parameters and changing the stock amount I will find out whether the item with this ean exist(if getItemByEan returns null) and if it does, I will call update. If it doesn't and it is called from something that may create items (e.g. shipmentImporter or web, salesImporter will not be able to create new items), it creates a new item

Method Summary

Modifier and Type	Method and Description
Item	changeItem(String newName, String newDescription, String newCategory, Integer newAlertThreshold, String newUnit, Item item) Updates existing item, but doesn't store it in db
Pair<Item,CreateOrUpdate>	createOrUpdateItem(String name, String description, String categoryName, Integer alertThreshold, String unit, long ean) Creates a new item, or updates it if it already exist but doesn't do the actual storing in db
List<Item>	getAllItems() Return all items
List<Item>	getAllItemsByCategory(String categoryName) Return all items with given category
Item	getItemByEan(long ean) Gets item by its ean
Item	storeItemInDb(Pair<Item,CreateOrUpdate> i) Item will be created in db
Item	updateItemFromWeb(long ean, int newAmount, Integer newThreshold, String newUnit) For updating items from web interface

Method Detail

createOrUpdateItem

Pair<Item,CreateOrUpdate> createOrUpdateItem(String name,
                                             String description,
                                             String categoryName,
                                             Integer alertThreshold,
                                             String unit,
                                             long ean)
                                      throws EntityDoesNotExistException

Creates a new item, or updates it if it already exist but doesn't do the actual storing in db

Parameters:

name - name of item

description - description of item, null if there should be none

categoryName - name of category of this item, must be already in db, cause @EntityDoesNotExistException if it is not there

alertThreshold - alert threshold for item, null if there is none

unit - unit for measuring the item

ean - ean of item, unique identifier

Returns:

Item that was created

Throws:

EntityDoesNotExistException - if category is not in db

changeItem

Item changeItem(String newName,
                String newDescription,
                String newCategory,
                Integer newAlertThreshold,
                String newUnit,
                Item item)
         throws EntityDoesNotExistException

Updates existing item, but doesn't store it in db

Parameters:

newName - New name of item

newDescription - New description of item, null if there should be none

newCategory - New category of item, must be in db, cause @EntityDoesNotExistException if it is not there

newAlertThreshold - New alert threshold of item, or null

newUnit - New unit of item

item - item to be changed

Returns:

Item that was changed

Throws:

EntityDoesNotExistException - if category is not in db

getItemByEan

Item getItemByEan(long ean)

Gets item by its ean

Parameters:

ean - ean of item

Returns:

Item with given ean

getAllItems

List<Item> getAllItems()

Return all items

Returns:

All items in db

getAllItemsByCategory

List<Item> getAllItemsByCategory(String categoryName)
                          throws EntityDoesNotExistException

Return all items with given category

Parameters:

categoryName - name of the category

Returns:

list of items belonging to the category

Throws:

EntityDoesNotExistException - if category is not in the db

updateItemFromWeb

Item updateItemFromWeb(long ean,
                       int newAmount,
                       Integer newThreshold,
                       String newUnit)
                throws ServiceException,
                       EntityDoesNotExistException

For updating items from web interface

Parameters:

ean - ean of item to be updated

newAmount - new amount of item

newThreshold - new threshold, null if it will be left unfilled or something

newUnit - new unit

Returns:

item that was updated

Throws:

ServiceException - if something goes wrong on the db layer and service layer cannot deal with it

EntityDoesNotExistException - if item with this ean is not in db

storeItemInDb

Item storeItemInDb(Pair<Item,CreateOrUpdate> i)
            throws ServiceException

Item will be created in db

Parameters:

i - item to be created

Returns:

item that was created

Throws:

ServiceException - if something goes wrong on the db layer and service layer cannot deal with it