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