src/org/mxchange/jproduct/model/product/Product.java

   1 /*
   2  * Copyright (C) 2016, 2017 Roland Häder
   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.jproduct.model.product;
  18
  19 import java.io.Serializable;
  20 import java.util.Date;
  21 import org.mxchange.jproduct.model.category.Category;
  22
  23 /**
  24  * An interface for in database storable products
  25  * <p>
  26  * @author Roland Häder<roland@mxchange.org>
  27  */
  28 public interface Product extends Serializable {
  29
  30         /**
  31          * Getter for created timestamp
  32          * <p>
  33          * @return Created timestamp
  34          */
  35         Date getProductCreated ();
  36
  37         /**
  38          * Setter for created timestamp
  39          * <p>
  40          * @param productCreated Created timestamp
  41          */
  42         void setProductCreated (final Date productCreated);
  43
  44         /**
  45          * Getter for product availability
  46          * <p>
  47          * @return Product availability
  48          */
  49         Boolean getProductAvailability ();
  50
  51         /**
  52          * Setter for product availability
  53          * <p>
  54          * @param productAvailability Product availability
  55          */
  56         void setProductAvailability (final Boolean productAvailability);
  57
  58         /**
  59          * Getter for product category id
  60          * <p>
  61          * @return Product category id
  62          */
  63         Category getProductCategory ();
  64
  65         /**
  66          * Setter for product category
  67          * <p>
  68          * @param productCategory Product category
  69          */
  70         void setProductCategory (final Category productCategory);
  71
  72         /**
  73          * Getter for id number, suitable for form fields.
  74          * <p>
  75          * @return Id number of product
  76          */
  77         Long getProductId ();
  78
  79         /**
  80          * Id number of product
  81          * <p>
  82          * @param productId the id number to set
  83          */
  84         void setProductId (final Long productId);
  85
  86         /**
  87          * Getter for product's net price
  88          * <p>
  89          * @return Product's net price
  90          */
  91         Float getProductNetPrice ();
  92
  93         /**
  94          * Setter for product's net price
  95          * <p>
  96          * @param productNetPrice Product's net price
  97          */
  98         void setProductNetPrice (final Float productNetPrice);
  99
 100         /**
 101          * Getter for product's tax rate
 102          * <p>
 103          * @return Product's tax rate
 104          */
 105         Float getProductTaxRate ();
 106
 107         /**
 108          * Setter for product's tax rate
 109          * <p>
 110          * @param productTaxRate Product's tax rate
 111          */
 112         void setProductTaxRate (final Float productTaxRate);
 113
 114         /**
 115          * Getter for product's gross price
 116          * <p>
 117          * @return Product's gross price
 118          */
 119         Float getProductGrossPrice ();
 120
 121         /**
 122          * Setter for product's gross price
 123          * <p>
 124          * @param productGrossPrice Product's gross price
 125          */
 126         void setProductGrossPrice (final Float productGrossPrice);
 127
 128         /**
 129          * Getter for title.
 130          * <p>
 131          * @return Title of product
 132          */
 133         String getProductTitle ();
 134
 135         /**
 136          * Title of product
 137          * <p>
 138          * @param productTitle the title to set
 139          */
 140         void setProductTitle (final String productTitle);
 141
 142         @Override
 143         boolean equals (final Object object);
 144
 145         @Override
 146         int hashCode ();
 147
 148 }