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