src/java/org/mxchange/pizzaapplication/beans/contact/PizzaAdminContactWebRequestController.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.pizzaapplication.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.DialableNumber;
  25 import org.mxchange.jphone.phonenumbers.cellphone.DialableCellphoneNumber;
  26 import org.mxchange.jphone.phonenumbers.mobileprovider.MobileProvider;
  27
  28 /**
  29  * Administrative interface for user beans
  30  * <p>
  31  * @author Roland Haeder<roland@mxchange.org>
  32  */
  33 public interface PizzaAdminContactWebRequestController extends Serializable {
  34
  35         /**
  36          * Adds contact data to database and redirects on success. If the contact is
  37          * already found, a proper exception is thrown.
  38          * <p>
  39          * @return Redirect outcome
  40          */
  41         String addContact ();
  42
  43         /**
  44          * Creates an instance from contact data
  45          * <p>
  46          * @return New contact instance
  47          */
  48         Contact createContactInstance ();
  49
  50         /**
  51          * Copies given contact's data to this controller
  52          * <p>
  53          * @param contact Contact instance
  54          */
  55         void copyContactToController (final Contact contact);
  56
  57         /**
  58          * Edits cuirrently loaded contact's data in database.
  59          * <p>
  60          * @return Redirect outcome
  61          */
  62         String editContactData ();
  63
  64         /**
  65          * Getter for cellphone id
  66          * <p>
  67          * @return Cellphone id
  68          */
  69         Long getCellphoneId ();
  70
  71         /**
  72          * Setter for cellphone id
  73          * <p>
  74          * @param cellphoneId Cellphone id
  75          */
  76         void setCellphoneId (final Long cellphoneId);
  77
  78         /**
  79          * Getter for fax id
  80          * <p>
  81          * @return Fax id
  82          */
  83         Long getFaxId ();
  84
  85         /**
  86          * Setter for fax id
  87          * <p>
  88          * @param faxId Fax id
  89          */
  90         void setFaxId (final Long faxId);
  91
  92         /**
  93          * Getter for land-line id
  94          * <p>
  95          * @return Land-line id
  96          */
  97         Long getLandLineId ();
  98
  99         /**
 100          * Setter for land-line id
 101          * <p>
 102          * @param landLineId Land-line id
 103          */
 104         void setLandLineId (final Long landLineId);
 105
 106         /**
 107          * Getter for birth day
 108          * <p>
 109          * @return Birth day
 110          */
 111         Date getBirthday ();
 112
 113         /**
 114          * Setter for birth day
 115          * <p>
 116          * @param birthday Birth day
 117          */
 118         void setBirthday (final Date birthday);
 119
 120         /**
 121          * Getter for ellphone number's carrier
 122          * <p>
 123          * @return Cellphone number's carrier
 124          */
 125         MobileProvider getCellphoneCarrier ();
 126
 127         /**
 128          * Setter for cellphone number's carrier prefix
 129          * <p>
 130          * @param cellphoneCarrier Cellphone number's carrier prefix
 131          */
 132         void setCellphoneCarrier (final MobileProvider cellphoneCarrier);
 133
 134         /**
 135          * Getter for ellphone number
 136          * <p>
 137          * @return Cellphone number
 138          */
 139         Long getCellphoneNumber ();
 140
 141         /**
 142          * Setter for ellphone number
 143          * <p>
 144          * @param cellphoneNumber Cellphone number
 145          */
 146         void setCellphoneNumber (final Long cellphoneNumber);
 147
 148         /**
 149          * City
 150          * <p>
 151          * @return the city
 152          */
 153         String getCity ();
 154
 155         /**
 156          * City
 157          * <p>
 158          * @param city the city to set
 159          */
 160         void setCity (final String city);
 161
 162         /**
 163          * Getter for comments
 164          * <p>
 165          * @return Comments
 166          */
 167         String getComment ();
 168
 169         /**
 170          * Setter for comment
 171          * <p>
 172          * @param comment Comments
 173          */
 174         void setComment (final String comment);
 175
 176         /**
 177          * Getter for contact id
 178          * <p>
 179          * @return Contact id
 180          */
 181         Long getContactId ();
 182
 183         /**
 184          * Setter for contact id
 185          * <p>
 186          * @param contactId Contact id
 187          */
 188         void setContactId (final Long contactId);
 189
 190         /**
 191          * Getter for country instance
 192          * <p>
 193          * @return Country instance
 194          */
 195         Country getCountry ();
 196
 197         /**
 198          * Setter for country instance
 199          * <p>
 200          * @param country Country instance
 201          */
 202         void setCountry (final Country country);
 203
 204         /**
 205          * Getter for email address
 206          * <p>
 207          * @return Email address
 208          */
 209         String getEmailAddress ();
 210
 211         /**
 212          * Setter for email address
 213          * <p>
 214          * @param emailAddress Email address
 215          */
 216         void setEmailAddress (final String emailAddress);
 217
 218         /**
 219          * Family name
 220          * <p>
 221          * @return the familyName
 222          */
 223         String getFamilyName ();
 224
 225         /**
 226          * Family name
 227          * <p>
 228          * @param familyName the familyName to set
 229          */
 230         void setFamilyName (final String familyName);
 231
 232         /**
 233          * Getter for fax number's area code
 234          * <p>
 235          * @return Fax number's area code
 236          */
 237         Integer getFaxAreaCode ();
 238
 239         /**
 240          * Setter for fax number's area code
 241          * <p>
 242          * @param faxAreaCode Fax number's area code
 243          */
 244         void setFaxAreaCode (final Integer faxAreaCode);
 245
 246         /**
 247          * Getter for fax's country instance
 248          * <p>
 249          * @return Fax' country instance
 250          */
 251         Country getFaxCountry ();
 252
 253         /**
 254          * Setter for fax's country instance
 255          * <p>
 256          * @param faxCountry Fax' country instance
 257          */
 258         void setFaxCountry (final Country faxCountry);
 259
 260         /**
 261          * Getter for fax number
 262          * <p>
 263          * @return Fax number
 264          */
 265         Long getFaxNumber ();
 266
 267         /**
 268          * Setter for fax number
 269          * <p>
 270          * @param faxNumber Fax number
 271          */
 272         void setFaxNumber (final Long faxNumber);
 273
 274         /**
 275          * First name
 276          * <p>
 277          * @return the first name
 278          */
 279         String getFirstName ();
 280
 281         /**
 282          * First name
 283          * <p>
 284          * @param firstName the first name to set
 285          */
 286         void setFirstName (final String firstName);
 287
 288         /**
 289          * Gender of the contact
 290          * <p>
 291          * @return the gender
 292          */
 293         Gender getGender ();
 294
 295         /**
 296          * Gender of the contact
 297          * <p>
 298          * @param gender the gender to set
 299          */
 300         void setGender (final Gender gender);
 301
 302         /**
 303          * House number
 304          * <p>
 305          * @return the houseNumber
 306          */
 307         Short getHouseNumber ();
 308
 309         /**
 310          * House number
 311          * <p>
 312          * @param houseNumber the houseNumber to set
 313          */
 314         void setHouseNumber (final Short houseNumber);
 315
 316         /**
 317          * Getter for phone number's area code
 318          * <p>
 319          * @return Phone number's area code
 320          */
 321         Integer getPhoneAreaCode ();
 322
 323         /**
 324          * Setter for phone number's area code
 325          * <p>
 326          * @param phoneAreaCode Phone number's area code
 327          */
 328         void setPhoneAreaCode (final Integer phoneAreaCode);
 329
 330         /**
 331          * Getter for phone number's country instance
 332          * <p>
 333          * @return Phone number's country instance
 334          */
 335         Country getPhoneCountry ();
 336
 337         /**
 338          * Setter for phone number's country instance
 339          * <p>
 340          * @param phoneCountry Phone number's country instance
 341          */
 342         void setPhoneCountry (final Country phoneCountry);
 343
 344         /**
 345          * Getter for phone number
 346          * <p>
 347          * @return Phone number
 348          */
 349         Long getPhoneNumber ();
 350
 351         /**
 352          * Setter for phone number
 353          * <p>
 354          * @param phoneNumber Phone number
 355          */
 356         void setPhoneNumber (final Long phoneNumber);
 357
 358         /**
 359          * Street
 360          * <p>
 361          * @return the street
 362          */
 363         String getStreet ();
 364
 365         /**
 366          * Street
 367          * <p>
 368          * @param street the street to set
 369          */
 370         void setStreet (final String street);
 371
 372         /**
 373          * Getter for title
 374          * <p>
 375          * @return title
 376          */
 377         String getTitle ();
 378
 379         /**
 380          * Setter for title
 381          * <p>
 382          * @param title Title
 383          */
 384         void setTitle (final String title);
 385
 386         /**
 387          * ZIP code
 388          * <p>
 389          * @return the zipCode
 390          */
 391         Integer getZipCode ();
 392
 393         /**
 394          * ZIP code
 395          * <p>
 396          * @param zipCode the zipCode to set
 397          */
 398         void setZipCode (final Integer zipCode);
 399
 400         /**
 401          * Returns a text respresentation of given phone number or null if not set.
 402          * <p>
 403          * @param phoneNumber Phone number
 404          * <p>
 405          * @return Text respresentation or null
 406          */
 407         String generatePhoneNumber (final DialableNumber phoneNumber);
 408
 409         /**
 410          * Returns a text representation of given cellphone number or null if not
 411          * set.
 412          * <p>
 413          * @param cellphoneNumber Cellphone number
 414          * <p>
 415          * @return Text respresentation or null
 416          */
 417         String generateCellphoneNumber (final DialableCellphoneNumber cellphoneNumber);
 418
 419 }