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.jcontactsbusiness.model.basicdata.BasicData;
  22 import org.mxchange.jfinancials.model.receipt.BillableReceipt;
  23 import org.mxchange.jproduct.model.category.Category;
  24 import org.mxchange.jproduct.model.product.Product;
  25
  26 /**
  27  * An interface for receipt items
  28  * <p>
  29  * @author Roland Häder<roland@mxchange.org>
  30  */
  31 public interface BillableReceiptItem extends Serializable {
  32
  33         /**
  34          * Getter for item's product category
  35          * <p>
  36          * @return Item's product category
  37          */
  38         Category getItemCategory ();
  39
  40         /**
  41          * Setter for item's product category
  42          * <p>
  43          * @param itemCategory Item's product category
  44          */
  45         void setItemCategory (final Category itemCategory);
  46
  47         /**
  48          * Getter when this receipt item has been created in database
  49          * <p>
  50          * @return When this item has been created
  51          */
  52         Date getItemCreated ();
  53
  54         /**
  55          * Setter when this receipt item has been created in database
  56          * <p>
  57          * @param itemCreated When this item has been created
  58          */
  59         void setItemCreated (final Date itemCreated);
  60
  61         /**
  62          * Getter for primary key
  63          * <p>
  64          * @return Primary key
  65          */
  66         Long getItemId ();
  67
  68         /**
  69          * Setter for primary key
  70          * <p>
  71          * @param itemId Primary key
  72          */
  73         void setItemId (final Long itemId);
  74
  75         /**
  76          * Getter for receipt instance
  77          * <p>
  78          * @return Receipt instance
  79          */
  80         BillableReceipt getItemReceipt ();
  81
  82         /**
  83          * Setter for receipt instance
  84          * <p>
  85          * @param itemReceipt Receipt instance
  86          */
  87         void setItemReceipt (final BillableReceipt itemReceipt);
  88
  89         /**
  90          * Getter for linked product
  91          * <p>
  92          * @return Product
  93          */
  94         Product getItemProduct ();
  95
  96         /**
  97          * Setter for linked product
  98          * <p>
  99          * @param itemProduct Product
 100          */
 101         void setItemProduct (final Product itemProduct);
 102
 103         /**
 104          * Getter for product discount as fixed value
 105          * <p>
 106          * @return Product discount as fixed value
 107          */
 108         Float getItemDiscountFixed ();
 109
 110         /**
 111          * Setter for product discount as fixed value
 112          * <p>
 113          * @param itemDiscountFixed Product discount as fixed value
 114          */
 115         void setItemDiscountFixed (final Float itemDiscountFixed);
 116
 117         /**
 118          * Getter for product discount in percents
 119          * <p>
 120          * @return Product discount in percents
 121          */
 122         Float getItemDiscountPercent ();
 123
 124         /**
 125          * Setter for product discount in percents
 126          * <p>
 127          * @param itemDiscountPercent Product discount in percents
 128          */
 129         void setItemDiscountPercent (final Float itemDiscountPercent);
 130
 131         /**
 132          * Getter for product quantity
 133          * <p>
 134          * @return Product quantity
 135          */
 136         Short getItemProductQuantity ();
 137
 138         /**
 139          * Setter for product quantity
 140          * <p>
 141          * @param itemProductQuantity Product quantity
 142          */
 143         void setItemProductQuantity (final Short itemProductQuantity);
 144
 145         /**
 146          * Getter for item's net price
 147          * <p>
 148          * @return Item's net price
 149          */
 150         Float getItemNetPrice ();
 151
 152         /**
 153          * Setter for item's net price
 154          * <p>
 155          * @param itemNetPrice Item's net price
 156          */
 157         void setItemNetPrice (final Float itemNetPrice);
 158
 159         /**
 160          * Getter for item's tax rate
 161          * <p>
 162          * @return Item's tax rate
 163          */
 164         Float getItemTaxRate ();
 165
 166         /**
 167          * Setter for item's tax rate
 168          * <p>
 169          * @param itemTaxRate Item's tax rate
 170          */
 171         void setItemTaxRate (final Float itemTaxRate);
 172
 173         /**
 174          * Getter for item's gross price
 175          * <p>
 176          * @return Item's gross price
 177          */
 178         Float getItemGrossPrice ();
 179
 180         /**
 181          * Setter for item's gross price
 182          * <p>
 183          * @param itemGrossPrice Item's gross price
 184          */
 185         void setItemGrossPrice (final Float itemGrossPrice);
 186
 187         /**
 188          * Getter for manufacturer/producer of this item
 189          * <p>
 190          * @return Manufacturer/producer of this item
 191          */
 192         BasicData getItemManufacturer ();
 193
 194         /**
 195          * Setter for manufacturer/producer of this item
 196          * <p>
 197          * @param itemManufacturer Manufacturer/producer of this item
 198          */
 199         void setItemManufacturer (final BasicData itemManufacturer);
 200
 201         /**
 202          * Getter for item brand name
 203          * <p>
 204          * @return Item brand name
 205          */
 206         String getItemBrandName ();
 207
 208         /**
 209          * Setter for item brand name
 210          * <p>
 211          * @param itemBrandName Item brand name
 212          */
 213         void setItemBrandName (final String itemBrandName);
 214
 215         /**
 216          * Getter for item number
 217          * <p>
 218          * @return Item number
 219          */
 220         Long getItemNumber ();
 221
 222         /**
 223          * Setter for item number
 224          * <p>
 225          * @param itemNumber Item number
 226          */
 227         void setItemNumber (final Long itemNumber);
 228
 229         @Override
 230         boolean equals (final Object object);
 231
 232         @Override
 233         int hashCode ();
 234
 235 }