src/org/mxchange/jfinancials/model/income/BillableIncome.java

   1 /*
   2  * Copyright (C) 2017 - 2022 Free Software Foundation
   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.income;
  18
  19 import java.io.Serializable;
  20 import java.math.BigDecimal;
  21 import java.util.Date;
  22 import org.mxchange.jfinancials.model.income.interval.FinancialInterval;
  23 import org.mxchange.jusercore.model.user.User;
  24
  25 /**
  26  * An interface for billable income
  27  * <p>
  28  * @author Roland Häder<roland@mxchange.org>
  29  */
  30 public interface BillableIncome extends Comparable<BillableIncome>, Serializable {
  31
  32         /**
  33          * Getter for income id (primary key)
  34          * <p>
  35          * @return Income id (primary key)
  36          */
  37         Long getIncomeId ();
  38
  39         /**
  40          * Setter for income id (primary key)
  41          * <p>
  42          * @param incomeId Income id (primary key)
  43          */
  44         void setIncomeId (final Long incomeId);
  45
  46         /**
  47          * Getter for whether income is enabled
  48          * <p>
  49          * @return Whether income is enabled
  50          */
  51         Boolean getIncomeEnabled ();
  52
  53         /**
  54          * Setter for whether income is enabled
  55          * <p>
  56          * @param incomeEnabled Whether income is enabled
  57          */
  58         void setIncomeEnabled (final Boolean incomeEnabled);
  59
  60         /**
  61          * Getter for income interval
  62          * <p>
  63          * @return Income interval
  64          */
  65         FinancialInterval getIncomeInterval ();
  66
  67         /**
  68          * Setter for income interval
  69          * <p>
  70          * @param incomeInterval Income interval
  71          */
  72         void setIncomeInterval (final FinancialInterval incomeInterval);
  73
  74         /**
  75          * Getter for income single amount
  76          * <p>
  77          * @return Income single amount
  78          */
  79         BigDecimal getIncomeSingleAmount ();
  80
  81         /**
  82          * Setter for income single amount
  83          * <p>
  84          * @param incomeSingleAmount Income single amount
  85          */
  86         void setIncomeSingleAmount (final BigDecimal incomeSingleAmount);
  87
  88         /**
  89          * Getter for income title
  90          * <p>
  91          * @return Income title
  92          */
  93         String getIncomeTitle ();
  94
  95         /**
  96          * Setter for income title
  97          * <p>
  98          * @param incomeTitle Income title
  99          */
 100         void setIncomeTitle (final String incomeTitle);
 101
 102         /**
 103          * Getter for connected user account
 104          * <p>
 105          * @return Connected user account
 106          */
 107         User getIncomeUser ();
 108
 109         /**
 110          * Setter for connected user account
 111          * <p>
 112          * @param incomeUser Connected user account
 113          */
 114         void setIncomeUser (final User incomeUser);
 115
 116         /**
 117          * Getter for income-created timestamp
 118          * <p>
 119          * @return Income-created timestamp
 120          */
 121         Date getIncomeEntryCreated ();
 122
 123         /**
 124          * Setter for income-created timestamp
 125          * <p>
 126          * @param incomeEntryCreated Income-created timestamp
 127          */
 128         void setIncomeEntryCreated (final Date incomeEntryCreated);
 129
 130         /**
 131          * Getter for income-updated timestamp
 132          * <p>
 133          * @return Income-updated timestamp
 134          */
 135         Date getIncomeEntryUpdated ();
 136
 137         /**
 138          * Setter for income-updated timestamp
 139          * <p>
 140          * @param incomeEntryUpdated Income-updated timestamp
 141          */
 142         void setIncomeEntryUpdated (final Date incomeEntryUpdated);
 143
 144         @Override
 145         boolean equals (final Object object);
 146
 147         @Override
 148         int hashCode ();
 149
 150 }