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

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   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.jshopcore.model.customer;
  18
  19 import java.io.Serializable;
  20 import java.util.Calendar;
  21 import org.mxchange.jcontacts.contact.Contact;
  22 import org.mxchange.jshopcore.model.customer.status.CustomerAccountStatus;
  23
  24 /**
  25  * A customer interface
  26  * <p>
  27  * @author Roland Haeder<roland@mxchange.org>
  28  */
  29 public interface Customer extends Serializable {
  30
  31         /**
  32          * Copies all attributes from other customer object to this
  33          * <p>
  34          * @param customer Source instance
  35          */
  36         void copyAll (final Customer customer);
  37
  38         /**
  39          * Getter for contact instance
  40          * <p>
  41          * @return Contact id number
  42          */
  43         Contact getContact ();
  44
  45         /**
  46          * Setter for contact instance
  47          * <p>
  48          * @param contact Contact instance
  49          */
  50         void setContact (final Contact contact);
  51
  52         /**
  53          * Getter for confirmation key
  54          * <p>
  55          * @return Confirmation key
  56          */
  57         String getCustomerConfirmKey ();
  58
  59         /**
  60          * Setter for confirmation key
  61          * <p>
  62          * @param customerConfirmKey Confirmation key
  63          */
  64         void setCustomerConfirmKey (final String customerConfirmKey);
  65
  66         /**
  67          * Getter for "created" timestamp
  68          * <p>
  69          * @return "created" timestamp
  70          */
  71         Calendar getCustomerCreated ();
  72
  73         /**
  74          * Setter for "created" timestamp
  75          * <p>
  76          * @param customerCreated "created" timestamp
  77          */
  78         void setCustomerCreated (final Calendar customerCreated);
  79
  80         /**
  81          * Getter for customer id number
  82          * <p>
  83          * @return Customer id number
  84          */
  85         Long getCustomerId ();
  86
  87         /**
  88          * Settte for customer id number
  89          * <p>
  90          * @param customerId Customer id number
  91          */
  92         void setCustomerId (final Long customerId);
  93
  94         /**
  95          * Getter for "locked" timestamp
  96          * <p>
  97          * @return "locked" timestamp
  98          */
  99         Calendar getCustomerLocked ();
 100
 101         /**
 102          * Getter for "locked" timestamp
 103          * <p>
 104          * @param customerLocked "locked" timestamp
 105          */
 106         void setCustomerLocked (final Calendar customerLocked);
 107
 108         /**
 109          * Getter for customer number
 110          * <p>
 111          * @return Customer number
 112          */
 113         String getCustomerNumber ();
 114
 115         /**
 116          * Setter for customer number
 117          * <p>
 118          * @param customerNumber Customer number
 119          */
 120         void setCustomerNumber (final String customerNumber);
 121
 122         /**
 123          * Getter for password hash
 124          * <p>
 125          * @return Password hash
 126          */
 127         String getCustomerPasswordHash ();
 128
 129         /**
 130          * Setter for password hash
 131          * <p>
 132          * @param customerPasswordHash Password hash
 133          */
 134         void setCustomerPasswordHash (final String customerPasswordHash);
 135
 136         /**
 137          * Getter for account status
 138          * <p>
 139          * @return Account status
 140          */
 141         CustomerAccountStatus getCustomerAccountStatus ();
 142
 143         /**
 144          * Setter for account status
 145          * <p>
 146          * @param customerStatus Account status
 147          */
 148         void setCustomerAccountStatus (final CustomerAccountStatus customerStatus);
 149 }