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

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