src/org/mxchange/jbonuscard/model/bonus_card/BonusCard.java

   1 /*
   2  * Copyright (C) 2017 - 2022 Free Software Foundation
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 3 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16 package org.mxchange.jbonuscard.model.bonus_card;
  17
  18 import java.io.Serializable;
  19 import java.util.Date;
  20 import org.mxchange.jcontacts.model.contact.Contact;
  21 import org.mxchange.jcontactsbusiness.model.basicdata.BasicData;
  22 import org.mxchange.jcustomercore.model.customer.Customer;
  23
  24 /**
  25  * A POJI for bonus cards
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 public interface BonusCard extends Comparable<BonusCard>, Serializable {
  30
  31         /**
  32          * Getter for bonus card's bar code
  33          * <p>
  34          * @return Bonus card's bar code
  35          */
  36         String getBonusCardBarCode ();
  37
  38         /**
  39          * Setter for bonus card's bar code
  40          * <p>
  41          * @param bonusCardBarCode Bonus card's bar code
  42          */
  43         void setBonusCardBarCode (final String bonusCardBarCode);
  44
  45         /**
  46          * Getter for bonus card's contact data
  47          * <p>
  48          * @return Bonus card's contact data
  49          */
  50         Contact getBonusCardContact ();
  51
  52         /**
  53          * Setter for bonus card's contact data
  54          * <p>
  55          * @param bonusCardContact Bonus card's contact data
  56          */
  57         void setBonusCardContact (final Contact bonusCardContact);
  58
  59         /**
  60          * Getter for bonus card's creation timestamp
  61          * <p>
  62          * @return Bonus card's creation timestamp
  63          */
  64         Date getBonusCardEntryCreated ();
  65
  66         /**
  67          * Setter for bonus card's creation timestamp
  68          * <p>
  69          * @param bonusCardCreated Bonus card's creation timestamp
  70          */
  71         void setBonusCardEntryCreated (final Date bonusCardCreated);
  72
  73         /**
  74          * Getter for bonus card's updated timestamp
  75          * <p>
  76          * @return Bonus card's updated timestamp
  77          */
  78         Date getBonusCardEntryUpdated ();
  79
  80         /**
  81          * Setter for bonus card's updated timestamp
  82          * <p>
  83          * @param bonusCardUpdated Bonus card's updated timestamp
  84          */
  85         void setBonusCardEntryUpdated (final Date bonusCardUpdated);
  86
  87         /**
  88          * Getter for bonus card's customer data
  89          * <p>
  90          * @return Bonus card's customer data
  91          */
  92         Customer getBonusCardCustomer ();
  93
  94         /**
  95          * Setter for bonus card's customer data
  96          * <p>
  97          * @param bonusCardCustomer Bonus card's customer data
  98          */
  99         void setBonusCardCustomer (final Customer bonusCardCustomer);
 100
 101         /**
 102          * Getter for bonus card's primary key
 103          * <p>
 104          * @return Bonus card's primary key
 105          */
 106         Long getBonusCardId ();
 107
 108         /**
 109          * Setter for bonus card's primary key
 110          * <p>
 111          * @param bonusCardId Bonus card's primary key
 112          */
 113         void setBonusCardId (final Long bonusCardId);
 114
 115         /**
 116          * Getter for bonus card's issuing company
 117          * <p>
 118          * @return Bonus card's issuing company
 119          */
 120         BasicData getBonusCardIssuer ();
 121
 122         /**
 123          * Setter for bonus card's issuing company
 124          * <p>
 125          * @param bonusCardIssuer Bonus card's issuing company
 126          */
 127         void setBonusCardIssuer (final BasicData bonusCardIssuer);
 128
 129         /**
 130          * Getter for bonus card's number (other than customer/bar code)
 131          * <p>
 132          * @return Bonus card's number
 133          */
 134         String getBonusCardNumber ();
 135
 136         /**
 137          * Setter for bonus card's number (other than customer/bar code)
 138          * <p>
 139          * @param bonusCardNumber Bonus card's number
 140          */
 141         void setBonusCardNumber (final String bonusCardNumber);
 142
 143         /**
 144          * Getter for bonus card's partnering/branding company
 145          * <p>
 146          * @return Bonus card's partnering/branding company
 147          */
 148         BasicData getBonusCardPartner ();
 149
 150         /**
 151          * Setter for bonus card's partnering/branding company
 152          * <p>
 153          * @param bonusCardPartner Bonus card's partnering/branding company
 154          */
 155         void setBonusCardPartner (final BasicData bonusCardPartner);
 156
 157         @Override
 158         boolean equals (final Object object);
 159
 160         @Override
 161         int hashCode ();
 162
 163 }