pb138.web.controllers

Class SoapBean

java.lang.Object

pb138.web.controllers.SoapBean

public class SoapBean
extends Object

SOAP API endpoint

Author:

Martin Schvarcbacher

Constructor Summary

Constructors

Constructor and Description
SoapBean()

Method Summary

Modifier and Type	Method and Description
ItemDto	changeItem(long ean, int currentCount, String unit, Integer alertThreshold) Changes the parameters of an item
String	exportAllItemsToXml() Exports all items from DB
List<CategoryDto>	getAllCategories() Returns all categories
List<ItemDto>	getAllItems() Returns a list of all items in DB
List<ItemDto>	getAllItemsForCategory(String categoryName) Gets all items in category
CategoryDto	getCategoryByName(String categoryName) Get category by categoryName
List<OverviewResultCategory>	getDailySalesForCategory(String category, Date dayStart, int numberOfDays) Get daily count of sold items from given category.
String	getDailySalesForCategoryXml(String category, Date dayStart, int numberOfDays) Get daily count of sold items from given category.
List<OverviewResultItem>	getDailySalesForItem(long ean, Date dayStart, int numberOfDays) Get daily count of sold items.
String	getDailySalesForItemXml(long ean, Date dayStart, int numberOfDays) Get daily count of sold items.
List<OverviewResultCategory>	getMonthlySalesForCategory(String category, Date monthStart, int numberOfMonths) Get monthly count of sold items from given category.
String	getMonthlySalesForCategoryXml(String category, Date monthStart, int numberOfMonths) Get monthly count of sold items from given category.
List<OverviewResultItem>	getMonthlySalesForItem(long ean, Date monthStart, int numberOfMonths) Get monthly count of sold items.
String	getMonthlySalesForItemXml(long ean, Date monthStart, int numberOfMonths) Get monthly count of sold items.
List<OverviewResultCategory>	getWeeklySalesForCategory(String category, Date weekStart, int numberOfWeeks) Get weekly count of sold items from given category.
String	getWeeklySalesForCategoryXml(String category, Date weekStart, int numberOfWeeks) Get weekly count of sold items from given category.
List<OverviewResultItem>	getWeeklySalesForItem(long ean, Date weekStart, int numberOfWeeks) Get weekly count of sold items.
String	getWeeklySalesForItemXml(long ean, Date weekStart, int numberOfWeeks) Get weekly count of sold items.
void	importXml(String xmlToImport) Import XML

Methods inherited from class java.lang.Object

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

Constructor Detail

SoapBean

public SoapBean()

Method Detail

importXml

public void importXml(String xmlToImport)
               throws ServiceException,
                      EntityDoesNotExistException,
                      NotEnoughStoredException,
                      XmlValidationException

Import XML

Parameters:

xmlToImport - encoded string

Throws:

ServiceException - DB failure

EntityDoesNotExistException - no such item in DB

NotEnoughStoredException - import places stock in the negative

XmlValidationException - invalid xml

exportAllItemsToXml

public String exportAllItemsToXml()
                           throws XmlValidationException

Exports all items from DB

Returns:

all items in XML

Throws:

XmlValidationException - on internal error

getAllItems

public List<ItemDto> getAllItems()

Returns a list of all items in DB

Returns:

all items

getAllItemsForCategory

public List<ItemDto> getAllItemsForCategory(String categoryName)
                                     throws EntityDoesNotExistException

Gets all items in category

Parameters:

categoryName - categoryName

Returns:

all items in category

Throws:

EntityDoesNotExistException - invalid category

getAllCategories

public List<CategoryDto> getAllCategories()

Returns all categories

Returns:

all categories

getCategoryByName

public CategoryDto getCategoryByName(String categoryName)

Get category by categoryName

Parameters:

categoryName - categoryName

Returns:

category

changeItem

public ItemDto changeItem(long ean,
                          int currentCount,
                          String unit,
                          Integer alertThreshold)
                   throws ServiceException,
                          EntityDoesNotExistException

Changes the parameters of an item

Parameters:

ean - ean

currentCount - current item count

unit - unit

alertThreshold - alert threshold

Returns:

changed item

Throws:

ServiceException - on internal failure

EntityDoesNotExistException - no such entity

getDailySalesForItemXml

public String getDailySalesForItemXml(long ean,
                                      Date dayStart,
                                      int numberOfDays)
                               throws EntityDoesNotExistException,
                                      XmlValidationException

Get daily count of sold items.

Parameters:

ean - ean of item to find its sales

dayStart - date of the first day of the overview

numberOfDays - number of days of the overview

Returns:

XML encoded list of 'OverviewResultItem's with timespan one day

Throws:

EntityDoesNotExistException - if item does not exists

XmlValidationException - on invalid xml

getWeeklySalesForItemXml

public String getWeeklySalesForItemXml(long ean,
                                       Date weekStart,
                                       int numberOfWeeks)
                                throws EntityDoesNotExistException,
                                       XmlValidationException

Get weekly count of sold items.

Parameters:

ean - ean of item to find its sales

weekStart - date of some day from the first week of the overview

numberOfWeeks - number of weeks of the overview

Returns:

XML encoded list of 'OverviewResultItem's with timespan one week

Throws:

EntityDoesNotExistException - if item does not exists

XmlValidationException - on invalid xml

getMonthlySalesForItemXml

public String getMonthlySalesForItemXml(long ean,
                                        Date monthStart,
                                        int numberOfMonths)
                                 throws EntityDoesNotExistException,
                                        XmlValidationException

Get monthly count of sold items.

Parameters:

ean - ean of item to find its sales

monthStart - date of some day from the first month of the overview

numberOfMonths - number of months of the overview

Returns:

XML encoded list of 'OverviewResultItem's with timespan one month

Throws:

EntityDoesNotExistException - if item does not exists

XmlValidationException - on invalid xml

getDailySalesForCategoryXml

public String getDailySalesForCategoryXml(String category,
                                          Date dayStart,
                                          int numberOfDays)
                                   throws EntityDoesNotExistException,
                                          XmlValidationException

Get daily count of sold items from given category.

Parameters:

category - name of category to find its sales

dayStart - date of the first day of the overview

numberOfDays - number of days of the overview

Returns:

XML encoded list of 'OverviewResultCategory's with timespan one day

Throws:

EntityDoesNotExistException - if category does not exists

XmlValidationException - on invalid xml

getWeeklySalesForCategoryXml

public String getWeeklySalesForCategoryXml(String category,
                                           Date weekStart,
                                           int numberOfWeeks)
                                    throws EntityDoesNotExistException,
                                           XmlValidationException

Get weekly count of sold items from given category.

Parameters:

category - name of category to find its sales

weekStart - date of some day from the first week of the overview

numberOfWeeks - number of weeks of the overview

Returns:

XML encoded list of 'OverviewResultCategory's with timespan one week

Throws:

EntityDoesNotExistException - if category does not exists

XmlValidationException - on invalid xml

getMonthlySalesForCategoryXml

public String getMonthlySalesForCategoryXml(String category,
                                            Date monthStart,
                                            int numberOfMonths)
                                     throws EntityDoesNotExistException,
                                            XmlValidationException

Get monthly count of sold items from given category.

Parameters:

category - name of category to find its sales

monthStart - date of some day from the first month of the overview

numberOfMonths - number of months of the overview

Returns:

XML encoded list of 'OverviewResultCategory's with timespan one month

Throws:

EntityDoesNotExistException - if category does not exists

XmlValidationException - on invalid xml

getDailySalesForItem

public List<OverviewResultItem> getDailySalesForItem(long ean,
                                                     Date dayStart,
                                                     int numberOfDays)
                                              throws EntityDoesNotExistException

Get daily count of sold items.

Parameters:

ean - ean of item to find its sales

dayStart - date of the first day of the overview

numberOfDays - number of days of the overview

Returns:

list of 'OverviewResultItem's with timespan one day

Throws:

EntityDoesNotExistException - if item does not exists

getWeeklySalesForItem

public List<OverviewResultItem> getWeeklySalesForItem(long ean,
                                                      Date weekStart,
                                                      int numberOfWeeks)
                                               throws EntityDoesNotExistException

Get weekly count of sold items.

Parameters:

ean - ean of item to find its sales

weekStart - date of some day from the first week of the overview

numberOfWeeks - number of weeks of the overview

Returns:

list of 'OverviewResultItem's with timespan one week

Throws:

EntityDoesNotExistException - if item does not exists

getMonthlySalesForItem

public List<OverviewResultItem> getMonthlySalesForItem(long ean,
                                                       Date monthStart,
                                                       int numberOfMonths)
                                                throws EntityDoesNotExistException

Get monthly count of sold items.

Parameters:

ean - ean of item to find its sales

monthStart - date of some day from the first month of the overview

numberOfMonths - number of months of the overview

Returns:

list of 'OverviewResultItem's with timespan one month

Throws:

EntityDoesNotExistException - if item does not exists

getDailySalesForCategory

public List<OverviewResultCategory> getDailySalesForCategory(String category,
                                                             Date dayStart,
                                                             int numberOfDays)
                                                      throws EntityDoesNotExistException

Get daily count of sold items from given category.

Parameters:

category - name of category to find its sales

dayStart - date of the first day of the overview

numberOfDays - number of days of the overview

Returns:

list of 'OverviewResultCategory's with timespan one day

Throws:

EntityDoesNotExistException - if category does not exists

getWeeklySalesForCategory

public List<OverviewResultCategory> getWeeklySalesForCategory(String category,
                                                              Date weekStart,
                                                              int numberOfWeeks)
                                                       throws EntityDoesNotExistException

Get weekly count of sold items from given category.

Parameters:

category - name of category to find its sales

weekStart - date of some day from the first week of the overview

numberOfWeeks - number of weeks of the overview

Returns:

list of 'OverviewResultCategory's with timespan one week

Throws:

EntityDoesNotExistException - if category does not exists

getMonthlySalesForCategory

public List<OverviewResultCategory> getMonthlySalesForCategory(String category,
                                                               Date monthStart,
                                                               int numberOfMonths)
                                                        throws EntityDoesNotExistException

Get monthly count of sold items from given category.

Parameters:

category - name of category to find its sales

monthStart - date of some day from the first month of the overview

numberOfMonths - number of months of the overview

Returns:

list of 'OverviewResultCategory's with timespan one month

Throws:

EntityDoesNotExistException - if category does not exists