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