src/org/mxchange/jshopcore/model/basket/Basket.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.jshopcore.model.basket;
  18
  19 import java.io.Serializable;
  20 import java.util.Map;
  21
  22 /**
  23  * An interface for baskets
  24  *
  25  * @author Roland Haeder
  26  * @param <T> Any addable basket items
  27  */
  28 public interface Basket<T extends AddableBasketItem> extends Serializable {
  29
  30         /**
  31          * Adds given item instance to this basket
  32          * @param item Item instance to add
  33          */
  34         public void addItem (final T item);
  35
  36         /**
  37          * Checks whether the given item as already been added. If the product's
  38          * item id number was found in basket, the corresponding item instance will be set
  39          *
  40          * @param item Item instance to check
  41          * @return Whether the given item has been found
  42          */
  43         public boolean isAdded (final T item);
  44
  45         /**
  46          * Checks if the basket is empty
  47          *
  48          * @return Whether the basket is empty
  49          */
  50         public boolean isEmpty ();
  51
  52         /**
  53          * Initializes this instance with given ServletContext
  54          */
  55         public void init ();
  56
  57         /**
  58          * Some "getter" for all entries in this basket
  59          *
  60          * @return Map on all basket items
  61          */
  62         public Map<Long, T> getAll ();
  63
  64         /**
  65          * Getter for last entry
  66          *
  67          * @return Last added item in basket
  68          */
  69         public T getLast ();
  70
  71         /**
  72          * Getter for last num rows
  73          *
  74          * @return Last num rows
  75          */
  76         public int getLastNumRows ();
  77 }