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.product.Product;
  23
  24 /**
  25  * An interface for receipt items
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 public interface BillableReceiptItem extends Serializable {
  30
  31         /**
  32          * Getter when this receipt item has been created in database
  33          * <p>
  34          * @return When this item has been created
  35          */
  36         Date getItemCreated ();
  37
  38         /**
  39          * Setter when this receipt item has been created in database
  40          * <p>
  41          * @param itemCreated When this item has been created
  42          */
  43         void setItemCreated (final Date itemCreated);
  44
  45         /**
  46          * Getter for primary key
  47          * <p>
  48          * @return Primary key
  49          */
  50         Long getItemId ();
  51
  52         /**
  53          * Setter for primary key
  54          * <p>
  55          * @param itemId Primary key
  56          */
  57         void setItemId (final Long itemId);
  58
  59         /**
  60          * Getter for receipt instance
  61          * <p>
  62          * @return Receipt instance
  63          */
  64         BillableReceipt getItemReceipt ();
  65
  66         /**
  67          * Setter for receipt instance
  68          * <p>
  69          * @param itemReceipt Receipt instance
  70          */
  71         void setItemReceipt (final BillableReceipt itemReceipt);
  72
  73         /**
  74          * Getter for linked product
  75          * <p>
  76          * @return Product
  77          */
  78         Product getItemProduct ();
  79
  80         /**
  81          * Setter for linked product
  82          * <p>
  83          * @param itemProduct Product
  84          */
  85         void setItemProduct (final Product itemProduct);
  86
  87         /**
  88          * Getter for product discount
  89          * <p>
  90          * @return Product discount
  91          */
  92         Float getItemProductDiscount ();
  93
  94         /**
  95          * Setter for product discount
  96          * <p>
  97          * @param productDiscount Product discount
  98          */
  99         void setItemProductDiscount (final Float productDiscount);
 100
 101         /**
 102          * Getter for product quantity
 103          * <p>
 104          * @return Product quantity
 105          */
 106         Long getItemProductQuantity ();
 107
 108         /**
 109          * Setter for product quantity
 110          * <p>
 111          * @param itemProductQuantity Product quantity
 112          */
 113         void setItemProductQuantity (final Long itemProductQuantity);
 114
 115         @Override
 116         boolean equals (final Object object);
 117
 118         @Override
 119         int hashCode ();
 120
 121 }