src/org/mxchange/jfinancials/model/receipt/Billable.java

   1 /*
   2  * Copyright (C) 2017 Roland Haeder<roland@mxchange.org>
   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;
  18
  19 import java.io.Serializable;
  20 import java.util.Calendar;
  21 import org.mxchange.jcontactsbusiness.BusinessContact;
  22 import org.mxchange.jshopcore.model.payment.PaymentType;
  23 import org.mxchange.jusercore.model.user.User;
  24
  25 /**
  26  * An interface for receipts
  27  * <p>
  28  * @author Roland Haeder<roland@mxchange.org>
  29  */
  30 public interface Billable extends Serializable {
  31
  32         /**
  33          * Getter for when this receipt has been created in database
  34          * <p>
  35          * @return Receipt creation timestamp
  36          */
  37         Calendar getReceiptCreated ();
  38
  39         /**
  40          * Setter for when this receipt has been created in database
  41          * <p>
  42          * @param receiptCreated Receipt creation timestamp
  43          */
  44         void setReceiptCreated (final Calendar receiptCreated);
  45
  46         /**
  47          * Getter for primary key
  48          * <p>
  49          * @return Primary key
  50          */
  51         Long getReceiptId ();
  52
  53         /**
  54          * Setter for primary key
  55          * <p>
  56          * @param receiptId Primary key
  57          */
  58         void setReceiptId (final Long receiptId);
  59
  60         /**
  61          * Getter for receipt's user
  62          * <p>
  63          * @return Receipt's user
  64          */
  65         User getReceiptUser ();
  66
  67         /**
  68          * Setter for receipt's user
  69          * <p>
  70          * @param receiptUser Receipt's user
  71          */
  72         void setReceiptUser (final User receiptUser);
  73
  74         /**
  75          * Getter for seller instance
  76          * <p>
  77          * @return Seller instance
  78          */
  79         BusinessContact getReceiptSeller ();
  80
  81         /**
  82          * Setter for seller instance
  83          * <p>
  84          * @param receiptSeller Seller instance
  85          */
  86         void setReceiptSeller (final BusinessContact receiptSeller);
  87
  88         /**
  89          * Getter for payment type
  90          * <p>
  91          * @return Payment type
  92          */
  93         PaymentType getReceiptPaymentType ();
  94
  95         /**
  96          * Setter for payment type
  97          * <p>
  98          * @param receiptPaymentType Payment type
  99          */
 100         void setReceiptPaymentType (final PaymentType receiptPaymentType);
 101
 102         @Override
 103         boolean equals (final Object object);
 104
 105         @Override
 106         int hashCode ();
 107
 108 }