src/java/org/mxchange/addressbook/beans/helper/AddressbookWebRequestHelperController.java

   1 /*
   2  * Copyright (C) 2016, 2017 Roland Häder GmbH
   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.helper;
  18
  19 import java.io.Serializable;
  20 import org.mxchange.jcontacts.contact.Contact;
  21 import org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber;
  22 import org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber;
  23 import org.mxchange.jphone.phonenumbers.mobile.DialableMobileNumber;
  24 import org.mxchange.jusercore.model.user.User;
  25
  26 /**
  27  * An interface for general bean helper
  28  * <p>
  29  * @author Roland Häder<roland@mxchange.org>
  30  */
  31 public interface AddressbookWebRequestHelperController extends Serializable {
  32
  33         /**
  34          * Copies currently set fax number's data to admin phone controller
  35          */
  36         void copyFaxNumberToController ();
  37
  38         /**
  39          * Copies currently set land-line number's data to admin phone controller
  40          */
  41         void copyLandLineNumberToController ();
  42
  43         /**
  44          * Copies currently set mobile number's data to admin phone controller
  45          */
  46         void copyMobileNumberToController ();
  47
  48         /**
  49          * Copies currently set contact instance's data to adminContactController
  50          */
  51         void copyContactToController ();
  52
  53         /**
  54          * Copies currently set user instance's data to adminUserController
  55          */
  56         void copyUserToController ();
  57
  58         /**
  59          * Returns a message key depending on if this contact is a user and/or a
  60          * contact. If this contact is unused, a default key is returned.
  61          * <p>
  62          * @param contact Contact instance to check
  63          * <p>
  64          * @return Message key
  65          */
  66         String getContactUsageMessageKey (final Contact contact);
  67
  68         /**
  69          * Getter for contact instance
  70          * <p>
  71          * @return Contact instance
  72          */
  73         Contact getContact ();
  74
  75         /**
  76          * Setter for contact instance
  77          * <p>
  78          * @param contact Contact instance
  79          */
  80         void setContact (final Contact contact);
  81
  82         /**
  83          * Getter for user instance
  84          * <p>
  85          * @return User instance
  86          */
  87         User getUser ();
  88
  89         /**
  90          * Setter for user instance
  91          * <p>
  92          * @param user User instance
  93          */
  94         void setUser (final User user);
  95
  96         /**
  97          * Getter for dialable mobile number
  98          * <p>
  99          * @return Dialable mobile number
 100          */
 101         DialableMobileNumber getMobileNumber ();
 102
 103         /**
 104          * Setter for dialable mobile number
 105          * <p>
 106          * @param mobileNumber Dialable mobile number
 107          */
 108         void setMobileNumber (final DialableMobileNumber mobileNumber);
 109
 110         /**
 111          * Getter for dialable land-line number
 112          * <p>
 113          * @return Dialable land-line number
 114          */
 115         DialableLandLineNumber getLandLineNumber ();
 116
 117         /**
 118          * Setter for dialable land-line number
 119          * <p>
 120          * @param landLine Dialable land-line number
 121          */
 122         void setLandLineNumber (final DialableLandLineNumber landLine);
 123
 124         /**
 125          * Getter for dialable fax number
 126          * <p>
 127          * @return Dialable fax number
 128          */
 129         DialableFaxNumber getFaxNumber ();
 130
 131         /**
 132          * Setter for dialable fax number
 133          * <p>
 134          * @param faxNumber Dialable fax number
 135          */
 136         void setFaxNumber (final DialableFaxNumber faxNumber);
 137
 138 }