src/java/org/mxchange/pizzaapplication/beans/controller/PizzaBean.java

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.pizzaapplication.beans.controller;
  18
  19 import java.util.Deque;
  20 import java.util.Iterator;
  21 import javax.faces.FacesException;
  22 import javax.servlet.ServletException;
  23 import javax.servlet.ServletRequest;
  24 import javax.servlet.http.HttpSession;
  25 import org.mxchange.jshop.beans.FrameworkBean;
  26 import org.mxchange.jshop.category.Category;
  27 import org.mxchange.jshop.exceptions.CategoryTitleAlreadyUsedException;
  28 import org.mxchange.jshop.exceptions.ProductTitleAlreadyUsedException;
  29 import org.mxchange.jshop.item.AddableBasketItem;
  30 import org.mxchange.jshop.product.Product;
  31
  32 /**
  33  *
  34  * @author Roland Haeder
  35  */
  36 public interface PizzaBean extends FrameworkBean {
  37         /**
  38          * Initializes this instance
  39          *
  40          * @throws FacesException If something was wrong
  41          */
  42         public void init () throws FacesException;
  43
  44         /**
  45          * Somewhat setter in session
  46          *
  47          * @param session Session instance
  48          * @param key Session key to set
  49          * @param value Value to set
  50          */
  51         public void setValueInSession (final HttpSession session, final String key, final Object value);
  52
  53         /**
  54          * Some "getter" for an iterator of only available products
  55          *
  56          * @return Only available products
  57          * @throws javax.servlet.ServletException If anything went wrong
  58          */
  59         public Iterator<Product> getAvailableProductsIterator () throws ServletException;
  60
  61         /**
  62          * Some "getter" for an iterator of all products
  63          *
  64          * @return All products
  65          * @throws javax.servlet.ServletException If anything went wrong
  66          */
  67         public Iterator<Product> getAllProductsIterator () throws ServletException;
  68
  69         /**
  70          * Some "getter" for an iterator of all categories
  71          *
  72          * @return All categories
  73          * @throws javax.servlet.ServletException If anything went wrong
  74          */
  75         public Iterator<Category> getAllCategoriesIterator () throws ServletException;
  76
  77         /**
  78          * Some "getter" for a linked list of only available products
  79          *
  80          * @return Only available products
  81          * @throws javax.servlet.ServletException If anything went wrong
  82          */
  83         public Deque<Product> getAvailableProducts () throws ServletException;
  84
  85         /**
  86          * Some "getter" for a linked list of all products
  87          *
  88          * @return All products
  89          * @throws javax.servlet.ServletException If anything went wrong
  90          */
  91         public Deque<Product> getAllProducts () throws ServletException;
  92
  93         /**
  94          * Some "getter" for a linked list of all categories
  95          *
  96          * @return All categories
  97          * @throws javax.servlet.ServletException If anything went wrong
  98          */
  99         public Deque<Category> getAllCategories () throws ServletException;
 100
 101         /**
 102          * Checks if given Product instance is available and returns a printable
 103          * (human-readable) string.
 104          *
 105          * @param product Product instance to check
 106          * @return Human-readable version of product availability
 107          */
 108         public String getPrintableProduktAvailability (final Product product);
 109
 110         /**
 111          * Returns a printable (human-readable) string of product's category
 112          *
 113          * @param product Product instance to check
 114          * @return Human-readable version of product availability
 115          * @throws javax.servlet.ServletException If something unexpected happened
 116          */
 117         public String getPrintableProduktCategory (final Product product) throws ServletException;
 118
 119         /**
 120          * Adds given category data from request to database
 121          *
 122          * @param request Request instance
 123          * @throws javax.servlet.ServletException If something unexpected happened
 124          * @throws org.mxchange.jshop.exceptions.CategoryTitleAlreadyUsedException If the given title is already used
 125          */
 126         public void doAdminAddCategory (final ServletRequest request) throws ServletException, CategoryTitleAlreadyUsedException;
 127
 128         /**
 129          * Adds given product data from request to database
 130          *
 131          * @param request Request instance
 132          * @throws javax.servlet.ServletException If something unexpected happened
 133          * @throws org.mxchange.jshop.exceptions.ProductTitleAlreadyUsedException If the given product title is already used
 134          */
 135         public void doAdminAddProduct (final ServletRequest request) throws ServletException, ProductTitleAlreadyUsedException;
 136
 137         /**
 138          * Generates link HTML code for given category's parent id, if set. This
 139          * link then points to products.jsp?category_id=x
 140          *
 141          * @param category Category instance
 142          * @return HTML code
 143          */
 144         public String generateLinkForParent (final Category category);
 145
 146         /**
 147          * Handles admin product form requests
 148          *
 149          * @throws ServletException If something unexpected happened
 150          */
 151         public void doAdminHandleProductForms () throws ServletException;
 152
 153         /**
 154          * Handles admin category form requests
 155          *
 156          * @throws ServletException If something unexpected happened
 157          */
 158         public void doAdminHandleCategoryForms () throws ServletException;
 159
 160         /**
 161          * Some "getter" for a product from given item
 162          * @param item Item instance
 163          * @return A Product instance
 164          * @throws javax.servlet.ServletException If something bad happens
 165          */
 166         public Product getProduct (final AddableBasketItem item) throws ServletException;
 167 }