src/org/mxchange/jshopcore/model/product/Product.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.product;
  18
  19 import org.mxchange.jshopcore.ShopInterface;
  20
  21 /**
  22  * An interface for in database storable products
  23  *
  24  * @author Roland Haeder
  25  */
  26 public interface Product extends ShopInterface, Comparable<Product> {
  27         /**
  28          * Getter for id number, suitable for form fields.
  29          *
  30          * @return Id number of product
  31          */
  32         public Long getItemId ();
  33
  34         /**
  35          * Id number of product
  36          * @param id the id number to set
  37          */
  38         public void setItemId (final Long id);
  39
  40         /**
  41          * Getter for title.
  42          *
  43          * @return Title of product
  44          */
  45         public String getTitle ();
  46
  47         /**
  48          * Title of product
  49          * @param title the title to set
  50          */
  51         public void setTitle (final String title);
  52
  53         /**
  54          * Getter for raw price.
  55          *
  56          * @return Single price of product
  57          */
  58         public Float getPrice ();
  59
  60         /**
  61          * Price of product
  62          * @param price the price to set
  63          */
  64         public void setPrice (final Float price);
  65
  66         /**
  67          * Getter for product category id
  68          *
  69          * @return Product category id
  70          */
  71         public Long getCategoryId ();
  72
  73         /**
  74          * Setter for product category
  75          *
  76          * @param categoryId Product category
  77          */
  78         public void setCategoryId (final Long categoryId);
  79
  80         /**
  81          * Getter for product availability
  82          *
  83          * @return Product availability
  84          */
  85         public Boolean getAvailable ();
  86
  87         /**
  88          * Setter for product availability
  89          *
  90          * @param available Product availability
  91          */
  92         public void setAvailable (final Boolean available);
  93
  94         /**
  95          * Compare method
  96          * @param product Product to compare to
  97          * @return Comparison value
  98          */
  99         @Override
 100         public int compareTo (final Product product);
 101 }