src/org/mxchange/jcustomercore/model/customer/Customer.java

   1 /*
   2  * Copyright (C) 2016 - 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.jcustomercore.model.customer;
  18
  19 import java.io.Serializable;
  20 import java.util.Date;
  21 import org.mxchange.jcontacts.model.contact.Contact;
  22 import org.mxchange.jcustomercore.model.customer.status.CustomerAccountStatus;
  23
  24 /**
  25  * A customer POJI
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 public interface Customer extends Comparable<Customer>, Serializable {
  30
  31         /**
  32          * Getter for contact instance
  33          * <p>
  34          * @return Contact id number
  35          */
  36         Contact getCustomerContact ();
  37
  38         /**
  39          * Setter for contact instance
  40          * <p>
  41          * @param customerContact Contact instance
  42          */
  43         void setCustomerContact (final Contact customerContact);
  44
  45         /**
  46          * Getter for confirmation key
  47          * <p>
  48          * @return Confirmation key
  49          */
  50         String getCustomerConfirmKey ();
  51
  52         /**
  53          * Setter for confirmation key
  54          * <p>
  55          * @param customerConfirmKey Confirmation key
  56          */
  57         void setCustomerConfirmKey (final String customerConfirmKey);
  58
  59         /**
  60          * Getter for "created" timestamp
  61          * <p>
  62          * @return "created" timestamp
  63          */
  64         Date getCustomerEntryCreated ();
  65
  66         /**
  67          * Setter for "created" timestamp
  68          * <p>
  69          * @param customerEntryCreated "created" timestamp
  70          */
  71         void setCustomerEntryCreated (final Date customerEntryCreated);
  72
  73         /**
  74          * Getter for "updated" timestamp
  75          * <p>
  76          * @return "updated" timestamp
  77          */
  78         Date getCustomerEntryUpdated ();
  79
  80         /**
  81          * Setter for "updated" timestamp
  82          * <p>
  83          * @param customerEntryUpdated "updated" timestamp
  84          */
  85         void setCustomerEntryUpdated (final Date customerEntryUpdated);
  86
  87         /**
  88          * Getter for customer id number
  89          * <p>
  90          * @return Customer id number
  91          */
  92         Long getCustomerId ();
  93
  94         /**
  95          * Settte for customer id number
  96          * <p>
  97          * @param customerId Customer id number
  98          */
  99         void setCustomerId (final Long customerId);
 100
 101         /**
 102          * Getter for "locked" timestamp
 103          * <p>
 104          * @return "locked" timestamp
 105          */
 106         Date getCustomerLastLocked ();
 107
 108         /**
 109          * Getter for "locked" timestamp
 110          * <p>
 111          * @param customerLocked "locked" timestamp
 112          */
 113         void setCustomerLastLocked (final Date customerLocked);
 114
 115         /**
 116          * Getter for reason of last locked
 117          * <p>
 118          * @return Reason of last locked
 119          */
 120         String getCustomerLastLockedReason ();
 121
 122         /**
 123          * Setter for reason of last locked
 124          * <p>
 125          * @param lastLockedReason Reason of last locked
 126          */
 127         void setCustomerLastLockedReason (final String lastLockedReason);
 128
 129         /**
 130          * Getter for customer number
 131          * <p>
 132          * @return Customer number
 133          */
 134         String getCustomerNumber ();
 135
 136         /**
 137          * Setter for customer number
 138          * <p>
 139          * @param customerNumber Customer number
 140          */
 141         void setCustomerNumber (final String customerNumber);
 142
 143         /**
 144          * Getter for password hash
 145          * <p>
 146          * @return Password hash
 147          */
 148         String getCustomerPasswordHash ();
 149
 150         /**
 151          * Setter for password hash
 152          * <p>
 153          * @param customerPasswordHash Password hash
 154          */
 155         void setCustomerPasswordHash (final String customerPasswordHash);
 156
 157         /**
 158          * Getter for account status
 159          * <p>
 160          * @return Account status
 161          */
 162         CustomerAccountStatus getCustomerAccountStatus ();
 163
 164         /**
 165          * Setter for account status
 166          * <p>
 167          * @param customerStatus Account status
 168          */
 169         void setCustomerAccountStatus (final CustomerAccountStatus customerStatus);
 170
 171         @Override
 172         boolean equals (final Object object);
 173
 174         @Override
 175         int hashCode ();
 176
 177 }