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 org.mxchange.jcontacts.contact.gender.Gender;
  21 import org.mxchange.jusercore.model.user.User;
  22
  23 /**
  24  * An interface for user beans
  25  * <p>
  26  * @author Roland Haeder<roland@mxchange.org>
  27  */
  28 public interface UserWebController extends Serializable {
  29
  30         /**
  31          * Creates an instance from all properties
  32          * <p>
  33          * @return A user instance
  34          */
  35         public User createUserInstance ();
  36
  37         /**
  38          * Cellphone number
  39          * <p>
  40          * @return the cellphoneNumber
  41          */
  42         public String getCellphoneNumber ();
  43
  44         /**
  45          * Cellphone number
  46          * <p>
  47          * @param cellphoneNumber the cellphoneNumber to set
  48          */
  49         public void setCellphoneNumber (final String cellphoneNumber);
  50
  51         /**
  52          * City
  53          * <p>
  54          * @return the city
  55          */
  56         public String getCity ();
  57
  58         /**
  59          * City
  60          * <p>
  61          * @param city the city to set
  62          */
  63         public void setCity (final String city);
  64
  65         /**
  66          * Getter for comments
  67          * <p>
  68          * @return Comments
  69          */
  70         public String getComment ();
  71
  72         /**
  73          * Setter for comment
  74          * <p>
  75          * @param comment Comments
  76          */
  77         public void setComment (final String comment);
  78
  79         /**
  80          * Getter for user name
  81          * <p>
  82          * @return User name
  83          */
  84         public String getUserName ();
  85
  86         /**
  87          * Setter for user name
  88          * <p>
  89          * @param userName User name
  90          */
  91         public void setUserName (final String userName);
  92
  93         /**
  94          * Getter for unencrypted user password
  95          * <p>
  96          * @return Unencrypted user password
  97          */
  98         public String getUserPassword ();
  99
 100         /**
 101          * Setter for unencrypted user password
 102          * <p>
 103          * @param userPassword Unencrypted user password
 104          */
 105         public void setUserPassword (final String userPassword);
 106
 107         /**
 108          * Company name
 109          * <p>
 110          * @return the companyName
 111          */
 112         public String getCompanyName ();
 113
 114         /**
 115          * Company name
 116          * <p>
 117          * @param companyName the companyName to set
 118          */
 119         public void setCompanyName (final String companyName);
 120
 121         /**
 122          * Country code
 123          * <p>
 124          * @return the countryCode
 125          */
 126         public String getCountryCode ();
 127
 128         /**
 129          * Country code
 130          * <p>
 131          * @param countryCode the countryCode to set
 132          */
 133         public void setCountryCode (final String countryCode);
 134
 135         /**
 136          * Email address
 137          * <p>
 138          * @return the emailAddress
 139          */
 140         public String getEmailAddress ();
 141
 142         /**
 143          * Email address
 144          * <p>
 145          * @param emailAddress the emailAddress to set
 146          */
 147         public void setEmailAddress (final String emailAddress);
 148
 149         /**
 150          * Family name
 151          * <p>
 152          * @return the familyName
 153          */
 154         public String getFamilyName ();
 155
 156         /**
 157          * Family name
 158          * <p>
 159          * @param familyName the familyName to set
 160          */
 161         public void setFamilyName (final String familyName);
 162
 163         /**
 164          * Fax number
 165          * <p>
 166          * @return the faxNumber
 167          */
 168         public String getFaxNumber ();
 169
 170         /**
 171          * Fax number
 172          * <p>
 173          * @param faxNumber the faxNumber to set
 174          */
 175         public void setFaxNumber (final String faxNumber);
 176
 177         /**
 178          * First name
 179          * <p>
 180          * @return the first name
 181          */
 182         public String getFirstName ();
 183
 184         /**
 185          * First name
 186          * <p>
 187          * @param firstName the first name to set
 188          */
 189         public void setFirstName (final String firstName);
 190
 191         /**
 192          * Gender of the contact
 193          * <p>
 194          * @return the gender
 195          */
 196         public Gender getGender ();
 197
 198         /**
 199          * Gender of the contact
 200          * <p>
 201          * @param gender the gender to set
 202          */
 203         public void setGender (final Gender gender);
 204
 205         /**
 206          * House number
 207          * <p>
 208          * @return the houseNumber
 209          */
 210         public Short getHouseNumber ();
 211
 212         /**
 213          * House number
 214          * <p>
 215          * @param houseNumber the houseNumber to set
 216          */
 217         public void setHouseNumber (final Short houseNumber);
 218
 219         /**
 220          * Phone number
 221          * <p>
 222          * @return the phoneNumber
 223          */
 224         public String getPhoneNumber ();
 225
 226         /**
 227          * Phone number
 228          * <p>
 229          * @param phoneNumber the phoneNumber to set
 230          */
 231         public void setPhoneNumber (final String phoneNumber);
 232
 233         /**
 234          * Street
 235          * <p>
 236          * @return the street
 237          */
 238         public String getStreet ();
 239
 240         /**
 241          * Street
 242          * <p>
 243          * @param street the street to set
 244          */
 245         public void setStreet (final String street);
 246
 247         /**
 248          * ZIP code
 249          * <p>
 250          * @return the zipCode
 251          */
 252         public Integer getZipCode ();
 253
 254         /**
 255          * ZIP code
 256          * <p>
 257          * @param zipCode the zipCode to set
 258          */
 259         public void setZipCode (final Integer zipCode);
 260
 261         /**
 262          * Checks whether all required personal data is set
 263          * <p>
 264          * @return Whether the required personal data is set
 265          */
 266         public boolean isRequiredPersonalDataSet ();
 267 }