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

   1 /*
   2  * Copyright (C) 2017 - 2024 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.jbonuscard.model.bonus_card;
  18
  19 import java.io.Serializable;
  20 import java.util.Date;
  21 import org.mxchange.jcontacts.model.contact.Contact;
  22 import org.mxchange.jcontactsbusiness.model.basicdata.BasicData;
  23 import org.mxchange.jcustomercore.model.customer.Customer;
  24
  25 /**
  26  * A POJI for bonus cards
  27  * <p>
  28  * @author Roland Häder<roland@mxchange.org>
  29  */
  30 public interface BonusCard extends Comparable<BonusCard>, Serializable {
  31
  32         /**
  33          * Getter for bonus card's bar code
  34          * <p>
  35          * @return Bonus card's bar code
  36          */
  37         String getBonusCardBarCode ();
  38
  39         /**
  40          * Setter for bonus card's bar code
  41          * <p>
  42          * @param bonusCardBarCode Bonus card's bar code
  43          */
  44         void setBonusCardBarCode (final String bonusCardBarCode);
  45
  46         /**
  47          * Getter for bonus card's contact data
  48          * <p>
  49          * @return Bonus card's contact data
  50          */
  51         Contact getBonusCardContact ();
  52
  53         /**
  54          * Setter for bonus card's contact data
  55          * <p>
  56          * @param bonusCardContact Bonus card's contact data
  57          */
  58         void setBonusCardContact (final Contact bonusCardContact);
  59
  60         /**
  61          * Getter for bonus card's creation timestamp
  62          * <p>
  63          * @return Bonus card's creation timestamp
  64          */
  65         Date getBonusCardEntryCreated ();
  66
  67         /**
  68          * Setter for bonus card's creation timestamp
  69          * <p>
  70          * @param bonusCardCreated Bonus card's creation timestamp
  71          */
  72         void setBonusCardEntryCreated (final Date bonusCardCreated);
  73
  74         /**
  75          * Getter for bonus card's updated timestamp
  76          * <p>
  77          * @return Bonus card's updated timestamp
  78          */
  79         Date getBonusCardEntryUpdated ();
  80
  81         /**
  82          * Setter for bonus card's updated timestamp
  83          * <p>
  84          * @param bonusCardUpdated Bonus card's updated timestamp
  85          */
  86         void setBonusCardEntryUpdated (final Date bonusCardUpdated);
  87
  88         /**
  89          * Getter for bonus card's customer data
  90          * <p>
  91          * @return Bonus card's customer data
  92          */
  93         Customer getBonusCardCustomer ();
  94
  95         /**
  96          * Setter for bonus card's customer data
  97          * <p>
  98          * @param bonusCardCustomer Bonus card's customer data
  99          */
 100         void setBonusCardCustomer (final Customer bonusCardCustomer);
 101
 102         /**
 103          * Getter for bonus card's primary key
 104          * <p>
 105          * @return Bonus card's primary key
 106          */
 107         Long getBonusCardId ();
 108
 109         /**
 110          * Setter for bonus card's primary key
 111          * <p>
 112          * @param bonusCardId Bonus card's primary key
 113          */
 114         void setBonusCardId (final Long bonusCardId);
 115
 116         /**
 117          * Getter for bonus card's issuing company
 118          * <p>
 119          * @return Bonus card's issuing company
 120          */
 121         BasicData getBonusCardIssuer ();
 122
 123         /**
 124          * Setter for bonus card's issuing company
 125          * <p>
 126          * @param bonusCardIssuer Bonus card's issuing company
 127          */
 128         void setBonusCardIssuer (final BasicData bonusCardIssuer);
 129
 130         /**
 131          * Getter for bonus card's number (other than customer/bar code)
 132          * <p>
 133          * @return Bonus card's number
 134          */
 135         String getBonusCardNumber ();
 136
 137         /**
 138          * Setter for bonus card's number (other than customer/bar code)
 139          * <p>
 140          * @param bonusCardNumber Bonus card's number
 141          */
 142         void setBonusCardNumber (final String bonusCardNumber);
 143
 144         /**
 145          * Getter for bonus card's partnering/branding company
 146          * <p>
 147          * @return Bonus card's partnering/branding company
 148          */
 149         BasicData getBonusCardPartner ();
 150
 151         /**
 152          * Setter for bonus card's partnering/branding company
 153          * <p>
 154          * @param bonusCardPartner Bonus card's partnering/branding company
 155          */
 156         void setBonusCardPartner (final BasicData bonusCardPartner);
 157
 158         @Override
 159         boolean equals (final Object object);
 160
 161         @Override
 162         int hashCode ();
 163
 164 }