src/org/mxchange/jfinancials/model/receipt_item/BillableReceiptItem.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.jfinancials.model.receipt_item;
  18
  19 import java.io.Serializable;
  20 import java.util.Date;
  21 import org.mxchange.jfinancials.model.receipt.BillableReceipt;
  22 import org.mxchange.jproduct.model.category.Category;
  23 import org.mxchange.jproduct.model.product.Product;
  24
  25 /**
  26  * An interface for receipt items
  27  * <p>
  28  * @author Roland Häder<roland@mxchange.org>
  29  */
  30 public interface BillableReceiptItem extends Serializable {
  31
  32         /**
  33          * Getter for item's product category
  34          * <p>
  35          * @return Item's product category
  36          */
  37         Category getItemCategory ();
  38
  39         /**
  40          * Setter for item's product category
  41          * <p>
  42          * @param itemCategory Item's product category
  43          */
  44         void setItemCategory (final Category itemCategory);
  45
  46         /**
  47          * Getter when this receipt item has been created in database
  48          * <p>
  49          * @return When this item has been created
  50          */
  51         Date getItemCreated ();
  52
  53         /**
  54          * Setter when this receipt item has been created in database
  55          * <p>
  56          * @param itemCreated When this item has been created
  57          */
  58         void setItemCreated (final Date itemCreated);
  59
  60         /**
  61          * Getter for primary key
  62          * <p>
  63          * @return Primary key
  64          */
  65         Long getItemId ();
  66
  67         /**
  68          * Setter for primary key
  69          * <p>
  70          * @param itemId Primary key
  71          */
  72         void setItemId (final Long itemId);
  73
  74         /**
  75          * Getter for receipt instance
  76          * <p>
  77          * @return Receipt instance
  78          */
  79         BillableReceipt getItemReceipt ();
  80
  81         /**
  82          * Setter for receipt instance
  83          * <p>
  84          * @param itemReceipt Receipt instance
  85          */
  86         void setItemReceipt (final BillableReceipt itemReceipt);
  87
  88         /**
  89          * Getter for linked product
  90          * <p>
  91          * @return Product
  92          */
  93         Product getItemProduct ();
  94
  95         /**
  96          * Setter for linked product
  97          * <p>
  98          * @param itemProduct Product
  99          */
 100         void setItemProduct (final Product itemProduct);
 101
 102         /**
 103          * Getter for product discount
 104          * <p>
 105          * @return Product discount
 106          */
 107         Float getItemProductDiscount ();
 108
 109         /**
 110          * Setter for product discount
 111          * <p>
 112          * @param productDiscount Product discount
 113          */
 114         void setItemProductDiscount (final Float productDiscount);
 115
 116         /**
 117          * Getter for product quantity
 118          * <p>
 119          * @return Product quantity
 120          */
 121         Short getItemProductQuantity ();
 122
 123         /**
 124          * Setter for product quantity
 125          * <p>
 126          * @param itemProductQuantity Product quantity
 127          */
 128         void setItemProductQuantity (final Short itemProductQuantity);
 129
 130         /**
 131          * Getter for item's net price
 132          * <p>
 133          * @return Item's net price
 134          */
 135         Float getItemNetPrice ();
 136
 137         /**
 138          * Setter for item's net price
 139          * <p>
 140          * @param itemNetPrice Item's net price
 141          */
 142         void setItemNetPrice (final Float itemNetPrice);
 143
 144         /**
 145          * Getter for item's tax rate
 146          * <p>
 147          * @return Item's tax rate
 148          */
 149         Float getItemTaxRate ();
 150
 151         /**
 152          * Setter for item's tax rate
 153          * <p>
 154          * @param itemTaxRate Item's tax rate
 155          */
 156         void setItemTaxRate (final Float itemTaxRate);
 157
 158         /**
 159          * Getter for item's gross price
 160          * <p>
 161          * @return Item's gross price
 162          */
 163         Float getItemGrossPrice ();
 164
 165         /**
 166          * Setter for item's gross price
 167          * <p>
 168          * @param itemGrossPrice Item's gross price
 169          */
 170         void setItemGrossPrice (final Float itemGrossPrice);
 171
 172         @Override
 173         boolean equals (final Object object);
 174
 175         @Override
 176         int hashCode ();
 177
 178 }