src/org/mxchange/jusercore/model/user/User.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.jusercore.model.user;
  18
  19 import java.io.Serializable;
  20 import java.util.Calendar;
  21 import org.mxchange.jcontacts.contact.Contact;
  22 import org.mxchange.jusercore.model.user.status.UserAccountStatus;
  23
  24 /**
  25  * A customer interface
  26  * <p>
  27  * @author Roland Haeder<roland@mxchange.org>
  28  */
  29 public interface User 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 User customer);
  37
  38         /**
  39          * Getter for account status
  40          * <p>
  41          * @return Account status
  42          */
  43         UserAccountStatus getUserAccountStatus ();
  44
  45         /**
  46          * Setter for account status
  47          * <p>
  48          * @param customerStatus Account status
  49          */
  50         void setUserAccountStatus (final UserAccountStatus customerStatus);
  51
  52         /**
  53          * Getter for confirmation key
  54          * <p>
  55          * @return Confirmation key
  56          */
  57         String getUserConfirmKey ();
  58
  59         /**
  60          * Setter for confirmation key
  61          * <p>
  62          * @param customerConfirmKey Confirmation key
  63          */
  64         void setUserConfirmKey (final String customerConfirmKey);
  65
  66         /**
  67          * Getter for contact instance
  68          * <p>
  69          * @return Contact id number
  70          */
  71         Contact getUserContact ();
  72
  73         /**
  74          * Setter for contact instance
  75          * <p>
  76          * @param contact Contact instance
  77          */
  78         void setUserContact (final Contact contact);
  79
  80         /**
  81          * Getter for "created" timestamp
  82          * <p>
  83          * @return "created" timestamp
  84          */
  85         Calendar getUserCreated ();
  86
  87         /**
  88          * Setter for "created" timestamp
  89          * <p>
  90          * @param customerCreated "created" timestamp
  91          */
  92         void setUserCreated (final Calendar customerCreated);
  93
  94         /**
  95          * Getter for encrypted password
  96          * <p>
  97          * @return Encrypted password
  98          */
  99         String getUserEncryptedPassword ();
 100
 101         /**
 102          * Setter for password hash
 103          * <p>
 104          * @param userEncryptedPassword Encrypted password
 105          */
 106         void setUserEncryptedPassword (final String userEncryptedPassword);
 107
 108         /**
 109          * Getter for customer id number
 110          * <p>
 111          * @return User id number
 112          */
 113         Long getUserId ();
 114
 115         /**
 116          * Settte for customer id number
 117          * <p>
 118          * @param customerId User id number
 119          */
 120         void setUserId (final Long customerId);
 121
 122         /**
 123          * Getter for "locked" timestamp
 124          * <p>
 125          * @return "locked" timestamp
 126          */
 127         Calendar getUserLocked ();
 128
 129         /**
 130          * Getter for "locked" timestamp
 131          * <p>
 132          * @param customerLocked "locked" timestamp
 133          */
 134         void setUserLocked (final Calendar customerLocked);
 135
 136         /**
 137          * Getter for customer number
 138          * <p>
 139          * @return User number
 140          */
 141         String getUserName ();
 142
 143         /**
 144          * Setter for customer number
 145          * <p>
 146          * @param customerNumber User number
 147          */
 148         void setUserName (final String customerNumber);
 149
 150         /**
 151          * Getter for public user profile flag
 152          * <p>
 153          * @return Whether the user has a public profile
 154          */
 155         Boolean getUserPublicProfile ();
 156
 157         /**
 158          * Setter for public user profile flag
 159          * <p>
 160          * @param userPublicProfile Whether the user has a public profile
 161          */
 162         void setUserPublicProfile (final Boolean userPublicProfile);
 163
 164         /**
 165          * Checks if object is a User instance and whether it matches with this
 166          * object.
 167          * <p>
 168          * @param object Object to be checked
 169          * @return Whether it matches this object
 170          */
 171         @Override
 172          boolean equals (final Object object);
 173
 174         /**
 175          * Hash code caluclation for this object
 176          * <p>
 177          * @return Hash code for this object
 178          */
 179         @Override
 180          int hashCode ();
 181 }