src/java/org/mxchange/addressbook/beans/user/UserWebController.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.addressbook.beans.user;
  18
  19 import java.io.Serializable;
  20 import java.util.Date;
  21 import org.mxchange.jcontacts.contact.gender.Gender;
  22 import org.mxchange.jcountry.data.Country;
  23 import org.mxchange.jphone.phonenumbers.cellphone.DialableCellphoneNumber;
  24 import org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber;
  25 import org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber;
  26 import org.mxchange.jusercore.model.user.User;
  27
  28 /**
  29  * An interface for user beans
  30  * <p>
  31  * @author Roland Haeder<roland@mxchange.org>
  32  */
  33 public interface UserWebController extends Serializable {
  34
  35         /**
  36          * Adds user's name and email address to bean's internal list
  37          * <p>
  38          * @param user User instance
  39          */
  40         public void addUserNameEmailAddress (final User user);
  41
  42         /**
  43          * Clears all data in this bean
  44          */
  45         public void clearData ();
  46
  47         /**
  48          * Copies given user into the controller
  49          * <p>
  50          * @param user User instance
  51          */
  52         public void copyUser (final User user);
  53
  54         /**
  55          * Creates an instance from all properties
  56          * <p>
  57          * @return A user instance
  58          */
  59         public User createUserInstance ();
  60
  61         /**
  62          * Getter for birth day
  63          * <p>
  64          * @return Birth day
  65          */
  66         public Date getBirthday ();
  67
  68         /**
  69          * Setter for birth day
  70          * <p>
  71          * @param birthday Birth day
  72          */
  73         public void setBirthday (final Date birthday);
  74
  75         /**
  76          * Cellphone number
  77          * <p>
  78          * @return the cellphoneNumber
  79          */
  80         public DialableCellphoneNumber getCellphoneNumber ();
  81
  82         /**
  83          * Cellphone number
  84          * <p>
  85          * @param cellphoneNumber the cellphoneNumber to set
  86          */
  87         public void setCellphoneNumber (final DialableCellphoneNumber cellphoneNumber);
  88
  89         /**
  90          * City
  91          * <p>
  92          * @return the city
  93          */
  94         public String getCity ();
  95
  96         /**
  97          * City
  98          * <p>
  99          * @param city the city to set
 100          */
 101         public void setCity (final String city);
 102
 103         /**
 104          * Getter for comments
 105          * <p>
 106          * @return Comments
 107          */
 108         public String getComment ();
 109
 110         /**
 111          * Setter for comment
 112          * <p>
 113          * @param comment Comments
 114          */
 115         public void setComment (final String comment);
 116
 117         /**
 118          * Country code
 119          * <p>
 120          * @return the countryCode
 121          */
 122         public Country getCountry ();
 123
 124         /**
 125          * Country code
 126          * <p>
 127          * @param countryCode the countryCode to set
 128          */
 129         public void setCountry (final Country countryCode);
 130
 131         /**
 132          * Getter for email address
 133          * <p>
 134          * @return Email address
 135          */
 136         public String getEmailAddress ();
 137
 138         /**
 139          * Setter for email address
 140          * <p>
 141          * @param emailAddress Email address
 142          */
 143         public void setEmailAddress (final String emailAddress);
 144
 145         /**
 146          * Getter for email address, repeated
 147          * <p>
 148          * @return the emailAddress, repeated
 149          */
 150         public String getEmailAddressRepeat ();
 151
 152         /**
 153          * Setter for email address repeated
 154          * <p>
 155          * @param emailAddressRepeat the emailAddress to set
 156          */
 157         public void setEmailAddressRepeat (final String emailAddressRepeat);
 158
 159         /**
 160          * Family name
 161          * <p>
 162          * @return the familyName
 163          */
 164         public String getFamilyName ();
 165
 166         /**
 167          * Family name
 168          * <p>
 169          * @param familyName the familyName to set
 170          */
 171         public void setFamilyName (final String familyName);
 172
 173         /**
 174          * Fax number
 175          * <p>
 176          * @return the faxNumber
 177          */
 178         public DialableFaxNumber getFaxNumber ();
 179
 180         /**
 181          * Fax number
 182          * <p>
 183          * @param faxNumber the faxNumber to set
 184          */
 185         public void setFaxNumber (final DialableFaxNumber faxNumber);
 186
 187         /**
 188          * First name
 189          * <p>
 190          * @return the first name
 191          */
 192         public String getFirstName ();
 193
 194         /**
 195          * First name
 196          * <p>
 197          * @param firstName the first name to set
 198          */
 199         public void setFirstName (final String firstName);
 200
 201         /**
 202          * Gender of the contact
 203          * <p>
 204          * @return the gender
 205          */
 206         public Gender getGender ();
 207
 208         /**
 209          * Gender of the contact
 210          * <p>
 211          * @param gender the gender to set
 212          */
 213         public void setGender (final Gender gender);
 214
 215         /**
 216          * House number
 217          * <p>
 218          * @return the houseNumber
 219          */
 220         public Short getHouseNumber ();
 221
 222         /**
 223          * House number
 224          * <p>
 225          * @param houseNumber the houseNumber to set
 226          */
 227         public void setHouseNumber (final Short houseNumber);
 228
 229         /**
 230          * Phone number
 231          * <p>
 232          * @return the phoneNumber
 233          */
 234         public DialableLandLineNumber getPhoneNumber ();
 235
 236         /**
 237          * Phone number
 238          * <p>
 239          * @param phoneNumber the phoneNumber to set
 240          */
 241         public void setPhoneNumber (final DialableLandLineNumber phoneNumber);
 242
 243         /**
 244          * Street
 245          * <p>
 246          * @return the street
 247          */
 248         public String getStreet ();
 249
 250         /**
 251          * Street
 252          * <p>
 253          * @param street the street to set
 254          */
 255         public void setStreet (final String street);
 256
 257         /**
 258          * Getter for user id
 259          * <p>
 260          * @return User id
 261          */
 262         public Long getUserId ();
 263
 264         /**
 265          * Setter for user id
 266          * <p>
 267          * @param userId User id
 268          */
 269         public void setUserId (final Long userId);
 270
 271         /**
 272          * Getter for user name
 273          * <p>
 274          * @return User name
 275          */
 276         public String getUserName ();
 277
 278         /**
 279          * Setter for user name
 280          * <p>
 281          * @param userName User name
 282          */
 283         public void setUserName (final String userName);
 284
 285         /**
 286          * Getter for unencrypted user password
 287          * <p>
 288          * @return Unencrypted user password
 289          */
 290         public String getUserPassword ();
 291
 292         /**
 293          * Setter for unencrypted user password
 294          * <p>
 295          * @param userPassword Unencrypted user password
 296          */
 297         public void setUserPassword (final String userPassword);
 298
 299         /**
 300          * Getter for unencrypted user password repeated
 301          * <p>
 302          * @return Unencrypted user password repeated
 303          */
 304         public String getUserPasswordRepeat ();
 305
 306         /**
 307          * Setter for unencrypted user password repeated
 308          * <p>
 309          * @param userPasswordRepeat Unencrypted user password repeated
 310          */
 311         public void setUserPasswordRepeat (final String userPasswordRepeat);
 312
 313         /**
 314          * ZIP code
 315          * <p>
 316          * @return the zipCode
 317          */
 318         public Integer getZipCode ();
 319
 320         /**
 321          * ZIP code
 322          * <p>
 323          * @param zipCode the zipCode to set
 324          */
 325         public void setZipCode (final Integer zipCode);
 326
 327         /**
 328          * Checks whether user instance's email address is used
 329          * <p>
 330          * @param user User instance's email address to check
 331          * <p>
 332          * @return Whether it is already used
 333          */
 334         public boolean isEmailAddressRegistered (final User user);
 335
 336         /**
 337          * Checks whether all required personal data is set
 338          * <p>
 339          * @return Whether the required personal data is set
 340          */
 341         public boolean isRequiredPersonalDataSet ();
 342
 343         /**
 344          * Checks whether same email addresses have been entered
 345          * <p>
 346          * @return Whether same email addresses have been entered
 347          */
 348         public boolean isSameEmailAddressEntered ();
 349
 350         /**
 351          * Checks whether same passwords has been entered
 352          * <p>
 353          * @return Whether same passwords has been entered
 354          */
 355         public boolean isSamePasswordEntered ();
 356
 357         /**
 358          * Checks whether given user instance's name is used
 359          * <p>
 360          * @param user User instance's name to check
 361          * <p>
 362          * @return Whether it is already used
 363          */
 364         public boolean isUserNameRegistered (final User user);
 365 }