src/org/mxchange/jshopeelib/beans/remote/basket/BasketSessionBeanRemote.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.jshopeelib.beans.remote.basket;
  18
  19 import java.rmi.RemoteException;
  20 import java.util.Map;
  21 import javax.ejb.Remote;
  22 import javax.faces.FacesException;
  23 import javax.faces.view.facelets.FaceletException;
  24 import org.mxchange.jshopcore.model.item.AddableBasketItem;
  25 import org.mxchange.jshopeelib.beans.ShopBean;
  26
  27 /**
  28  * An interface for a basket bean
  29  *
  30  * @author Roland Haeder
  31  */
  32 @Remote
  33 public interface BasketSessionBeanRemote extends ShopBean {
  34         /**
  35          * Initializes this instance. Please note that no checked exceptions can be
  36          * thrown as this method is invoked over @PostConstruct anotation.
  37          *
  38          * @throws FacesException If something was wrong
  39          */
  40         public void init () throws FaceletException;
  41
  42         /**
  43          * Adds given item instance to this basket
  44          * @param item Item instance to add
  45          * @throws java.rmi.RemoteException If something bad happens
  46          */
  47         public void addItem (final AddableBasketItem item) throws RemoteException;
  48
  49         /**
  50          * Adds given item instance to basket. Remember that the product instance
  51          * itself is not added. Instead a AddableBasketItem is created which holds
  52          * information about amoutn and item type.
  53          *
  54          * @param item Item instance
  55          * @throws java.rmi.RemoteException If something bad happens
  56          */
  57         public void addToBasket (final AddableBasketItem item) throws RemoteException;
  58
  59         /**
  60          * Checks if the basket is empty
  61          *
  62          * @return Whether the basket is empty
  63          * @throws java.rmi.RemoteException If something bad happens
  64          */
  65         public boolean isEmpty () throws RemoteException;
  66
  67         /**
  68          * Checks whether the given product as already been added. If the product's
  69          * item id number was found in basket, the corresponding item instance will be set
  70          *
  71          * @param item Item instance to check
  72          * @return Whether the given item has been found
  73          * @throws java.rmi.RemoteException If something bad happens
  74          */
  75         public boolean isAdded (final AddableBasketItem item) throws RemoteException;
  76
  77         /**
  78          * Getter for human-readable string from given key
  79          *
  80          * @param key Key to return
  81          * @return Human-readable message
  82          */
  83         public String getMessageStringFromKey (final String key);
  84
  85         /**
  86          * Some "getter" for all entries in this basket
  87          *
  88          * @return Map on all basket items
  89          * @throws java.rmi.RemoteException If something bad happens
  90          */
  91         public Map<Long, AddableBasketItem> getAll () throws RemoteException;
  92
  93         /**
  94          * Getter for last entry
  95          *
  96          * @return Last added item in basket
  97          * @throws java.rmi.RemoteException If something bad happens
  98          */
  99         public AddableBasketItem getLast () throws RemoteException;
 100
 101         /**
 102          * Getter for last num rows
 103          *
 104          * @return Last num rows
 105          */
 106         public int getLastNumRows ();
 107 }