src/java/org/mxchange/addressbook/beans/contact/AddressbookAdminContactWebRequestController.java

   1 /*
   2  * Copyright (C) 2016 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU Affero General Public License as
   6  * published by the Free Software Foundation, either version 3 of the
   7  * License, or (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 Affero General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Affero General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.addressbook.beans.contact;
  18
  19 import java.io.Serializable;
  20 import java.util.Date;
  21 import org.mxchange.jcontacts.contact.Contact;
  22 import org.mxchange.jcontacts.contact.gender.Gender;
  23 import org.mxchange.jcountry.data.Country;
  24 import org.mxchange.jphone.phonenumbers.mobileprovider.MobileProvider;
  25
  26 /**
  27  * An administrative interface for user beans
  28  * <p>
  29  * @author Roland Haeder<roland@mxchange.org>
  30  */
  31 public interface AddressbookAdminContactWebRequestController extends Serializable {
  32
  33         /**
  34          * Copies given contact's data to this controller
  35          * <p>
  36          * @param contact Contact instance
  37          */
  38         void copyContactToController (final Contact contact);
  39
  40         /**
  41          * Getter for cellphone id
  42          * <p>
  43          * @return Cellphone id
  44          */
  45         Long getCellphoneId ();
  46
  47         /**
  48          * Setter for cellphone id
  49          * <p>
  50          * @param cellphoneId Cellphone id
  51          */
  52         void setCellphoneId (final Long cellphoneId);
  53
  54         /**
  55          * Getter for fax id
  56          * <p>
  57          * @return Fax id
  58          */
  59         Long getFaxId ();
  60
  61         /**
  62          * Setter for fax id
  63          * <p>
  64          * @param faxId Fax id
  65          */
  66         void setFaxId (final Long faxId);
  67
  68         /**
  69          * Getter for land-line id
  70          * <p>
  71          * @return Land-line id
  72          */
  73         Long getLandLineId ();
  74
  75         /**
  76          * Setter for land-line id
  77          * <p>
  78          * @param landLineId Land-line id
  79          */
  80         void setLandLineId (final Long landLineId);
  81
  82         /**
  83          * Getter for birth day
  84          * <p>
  85          * @return Birth day
  86          */
  87         Date getBirthday ();
  88
  89         /**
  90          * Setter for birth day
  91          * <p>
  92          * @param birthday Birth day
  93          */
  94         void setBirthday (final Date birthday);
  95
  96         /**
  97          * Getter for ellphone number's carrier
  98          * <p>
  99          * @return Cellphone number's carrier
 100          */
 101         MobileProvider getCellphoneCarrier ();
 102
 103         /**
 104          * Setter for cellphone number's carrier prefix
 105          * <p>
 106          * @param cellphoneCarrier Cellphone number's carrier prefix
 107          */
 108         void setCellphoneCarrier (final MobileProvider cellphoneCarrier);
 109
 110         /**
 111          * Getter for ellphone number
 112          * <p>
 113          * @return Cellphone number
 114          */
 115         Long getCellphoneNumber ();
 116
 117         /**
 118          * Setter for ellphone number
 119          * <p>
 120          * @param cellphoneNumber Cellphone number
 121          */
 122         void setCellphoneNumber (final Long cellphoneNumber);
 123
 124         /**
 125          * City
 126          * <p>
 127          * @return the city
 128          */
 129         String getCity ();
 130
 131         /**
 132          * City
 133          * <p>
 134          * @param city the city to set
 135          */
 136         void setCity (final String city);
 137
 138         /**
 139          * Getter for comments
 140          * <p>
 141          * @return Comments
 142          */
 143         String getComment ();
 144
 145         /**
 146          * Setter for comment
 147          * <p>
 148          * @param comment Comments
 149          */
 150         void setComment (final String comment);
 151
 152         /**
 153          * Getter for contact id
 154          * <p>
 155          * @return Contact id
 156          */
 157         Long getContactId ();
 158
 159         /**
 160          * Setter for contact id
 161          * <p>
 162          * @param contactId Contact id
 163          */
 164         void setContactId (final Long contactId);
 165
 166         /**
 167          * Getter for country instance
 168          * <p>
 169          * @return Country instance
 170          */
 171         Country getCountry ();
 172
 173         /**
 174          * Setter for country instance
 175          * <p>
 176          * @param country Country instance
 177          */
 178         void setCountry (final Country country);
 179
 180         /**
 181          * Getter for email address
 182          * <p>
 183          * @return Email address
 184          */
 185         String getEmailAddress ();
 186
 187         /**
 188          * Setter for email address
 189          * <p>
 190          * @param emailAddress Email address
 191          */
 192         void setEmailAddress (final String emailAddress);
 193
 194         /**
 195          * Family name
 196          * <p>
 197          * @return the familyName
 198          */
 199         String getFamilyName ();
 200
 201         /**
 202          * Family name
 203          * <p>
 204          * @param familyName the familyName to set
 205          */
 206         void setFamilyName (final String familyName);
 207
 208         /**
 209          * Getter for fax number's area code
 210          * <p>
 211          * @return Fax number's area code
 212          */
 213         Integer getFaxAreaCode ();
 214
 215         /**
 216          * Setter for fax number's area code
 217          * <p>
 218          * @param faxAreaCode Fax number's area code
 219          */
 220         void setFaxAreaCode (final Integer faxAreaCode);
 221
 222         /**
 223          * Getter for fax's country instance
 224          * <p>
 225          * @return Fax' country instance
 226          */
 227         Country getFaxCountry ();
 228
 229         /**
 230          * Setter for fax's country instance
 231          * <p>
 232          * @param faxCountry Fax' country instance
 233          */
 234         void setFaxCountry (final Country faxCountry);
 235
 236         /**
 237          * Getter for fax number
 238          * <p>
 239          * @return Fax number
 240          */
 241         Long getFaxNumber ();
 242
 243         /**
 244          * Setter for fax number
 245          * <p>
 246          * @param faxNumber Fax number
 247          */
 248         void setFaxNumber (final Long faxNumber);
 249
 250         /**
 251          * First name
 252          * <p>
 253          * @return the first name
 254          */
 255         String getFirstName ();
 256
 257         /**
 258          * First name
 259          * <p>
 260          * @param firstName the first name to set
 261          */
 262         void setFirstName (final String firstName);
 263
 264         /**
 265          * Gender of the contact
 266          * <p>
 267          * @return the gender
 268          */
 269         Gender getGender ();
 270
 271         /**
 272          * Gender of the contact
 273          * <p>
 274          * @param gender the gender to set
 275          */
 276         void setGender (final Gender gender);
 277
 278         /**
 279          * House number
 280          * <p>
 281          * @return the houseNumber
 282          */
 283         Short getHouseNumber ();
 284
 285         /**
 286          * House number
 287          * <p>
 288          * @param houseNumber the houseNumber to set
 289          */
 290         void setHouseNumber (final Short houseNumber);
 291
 292         /**
 293          * Getter for phone number's area code
 294          * <p>
 295          * @return Phone number's area code
 296          */
 297         Integer getPhoneAreaCode ();
 298
 299         /**
 300          * Setter for phone number's area code
 301          * <p>
 302          * @param phoneAreaCode Phone number's area code
 303          */
 304         void setPhoneAreaCode (final Integer phoneAreaCode);
 305
 306         /**
 307          * Getter for phone number's country instance
 308          * <p>
 309          * @return Phone number's country instance
 310          */
 311         Country getPhoneCountry ();
 312
 313         /**
 314          * Setter for phone number's country instance
 315          * <p>
 316          * @param phoneCountry Phone number's country instance
 317          */
 318         void setPhoneCountry (final Country phoneCountry);
 319
 320         /**
 321          * Getter for phone number
 322          * <p>
 323          * @return Phone number
 324          */
 325         Long getPhoneNumber ();
 326
 327         /**
 328          * Setter for phone number
 329          * <p>
 330          * @param phoneNumber Phone number
 331          */
 332         void setPhoneNumber (final Long phoneNumber);
 333
 334         /**
 335          * Street
 336          * <p>
 337          * @return the street
 338          */
 339         String getStreet ();
 340
 341         /**
 342          * Street
 343          * <p>
 344          * @param street the street to set
 345          */
 346         void setStreet (final String street);
 347
 348         /**
 349          * ZIP code
 350          * <p>
 351          * @return the zipCode
 352          */
 353         Integer getZipCode ();
 354
 355         /**
 356          * ZIP code
 357          * <p>
 358          * @param zipCode the zipCode to set
 359          */
 360         void setZipCode (final Integer zipCode);
 361
 362 }