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          * Some "getter" for HTML code 'checked="checked"' if the product is choosen
  46          *
  47          * @param product Product instance
  48          * @param request Request instance
  49          * @param session Session instance
  50          * @return Whether the product is choosen
  51          */
  52         public String getCheckedHtmlFromProduct (final Product product, final ServletRequest request, final HttpSession session);
  53
  54         /**
  55          * Some "getter" for HTML code 'disabled="disabled"' for e.g. submit buttons
  56          *
  57          * @param request Request instance
  58          * @param session Session instance
  59          * @return Whether the product is choosen
  60          * @throws javax.servlet.ServletException If something unexpected happened
  61          */
  62         public String getDisabledHtmlFromSession (final ServletRequest request, final HttpSession session) throws ServletException;
  63
  64         /**
  65          * Somewhat setter in session
  66          *
  67          * @param session Session instance
  68          * @param key Session key to set
  69          * @param value Value to set
  70          */
  71         public void setValueInSession (final HttpSession session, final String key, final Object value);
  72
  73         /**
  74          * Some "getter" for an iterator of only available products
  75          *
  76          * @return Only available products
  77          * @throws javax.servlet.ServletException If anything went wrong
  78          */
  79         public Iterator<Product> getAvailableProductsIterator () throws ServletException;
  80
  81         /**
  82          * Some "getter" for an iterator of all products
  83          *
  84          * @return All products
  85          * @throws javax.servlet.ServletException If anything went wrong
  86          */
  87         public Iterator<Product> getAllProductsIterator () throws ServletException;
  88
  89         /**
  90          * Some "getter" for an iterator of all categories
  91          *
  92          * @return All categories
  93          * @throws javax.servlet.ServletException If anything went wrong
  94          */
  95         public Iterator<Category> getAllCategoriesIterator () throws ServletException;
  96
  97         /**
  98          * Some "getter" for a linked list of only available products
  99          *
 100          * @return Only available products
 101          * @throws javax.servlet.ServletException If anything went wrong
 102          */
 103         public Deque<Product> getAvailableProducts () throws ServletException;
 104
 105         /**
 106          * Some "getter" for a linked list of all products
 107          *
 108          * @return All products
 109          * @throws javax.servlet.ServletException If anything went wrong
 110          */
 111         public Deque<Product> getAllProducts () throws ServletException;
 112
 113         /**
 114          * Some "getter" for a linked list of all categories
 115          *
 116          * @return All categories
 117          * @throws javax.servlet.ServletException If anything went wrong
 118          */
 119         public Deque<Category> getAllCategories () throws ServletException;
 120
 121         /**
 122          * Checks if given Product instance is available and returns a printable
 123          * (human-readable) string.
 124          *
 125          * @param product Product instance to check
 126          * @return Human-readable version of product availability
 127          */
 128         public String getPrintableProduktAvailability (final Product product);
 129
 130         /**
 131          * Returns a printable (human-readable) string of product's category
 132          *
 133          * @param product Product instance to check
 134          * @return Human-readable version of product availability
 135          * @throws javax.servlet.ServletException If something unexpected happened
 136          */
 137         public String getPrintableProduktCategory (final Product product) throws ServletException;
 138
 139         /**
 140          * Adds given category data from request to database
 141          *
 142          * @param request Request instance
 143          * @throws javax.servlet.ServletException If something unexpected happened
 144          * @throws org.mxchange.jshop.exceptions.CategoryTitleAlreadyUsedException If the given title is already used
 145          */
 146         public void doAdminAddCategory (final ServletRequest request) throws ServletException, CategoryTitleAlreadyUsedException;
 147
 148         /**
 149          * Adds given product data from request to database
 150          *
 151          * @param request Request instance
 152          * @throws javax.servlet.ServletException If something unexpected happened
 153          * @throws org.mxchange.jshop.exceptions.ProductTitleAlreadyUsedException If the given product title is already used
 154          */
 155         public void doAdminAddProduct (final ServletRequest request) throws ServletException, ProductTitleAlreadyUsedException;
 156
 157         /**
 158          * Generates link HTML code for given category's parent id, if set. This
 159          * link then points to products.jsp?category_id=x
 160          *
 161          * @param category Category instance
 162          * @return HTML code
 163          */
 164         public String generateLinkForParent (final Category category);
 165
 166         /**
 167          * Handles admin product form requests
 168          *
 169          * @throws ServletException If something unexpected happened
 170          */
 171         public void doAdminHandleProductForms () throws ServletException;
 172
 173         /**
 174          * Handles admin category form requests
 175          *
 176          * @throws ServletException If something unexpected happened
 177          */
 178         public void doAdminHandleCategoryForms () throws ServletException;
 179
 180         /**
 181          * Some "getter" for a product from given item
 182          * @param item Item instance
 183          * @return A Product instance
 184          * @throws javax.servlet.ServletException If something bad happens
 185          */
 186         public Product getProduct (final AddableBasketItem item) throws ServletException;
 187 }