src/java/org/mxchange/jjobs/beans/helper/JobsWebRequestController.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.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 Haeder<roland@mxchange.org>
  30  */
  31 public interface JobsWebRequestController extends Serializable {
  32
  33         /**
  34          * Copies currently set mobile instance's data to admin phone controller
  35          */
  36         void copyMobileNumberToController ();
  37
  38         /**
  39          * Copies currently set contact instance's data to adminContactController
  40          */
  41         void copyContactToController ();
  42
  43         /**
  44          * Copies currently set user instance's data to adminUserController
  45          */
  46         void copyUserToController ();
  47
  48         /**
  49          * Returns a message key depending on if this contact is a user and/or a
  50          * contact. If this contact is unused, a default key is returned.
  51          * <p>
  52          * @param contact Contact instance to check
  53          * <p>
  54          * @return Message key
  55          */
  56         String getContactUsageMessageKey (final Contact contact);
  57
  58         /**
  59          * Getter for contact instance
  60          * <p>
  61          * @return Contact instance
  62          */
  63         Contact getContact ();
  64
  65         /**
  66          * Setter for contact instance
  67          * <p>
  68          * @param contact Contact instance
  69          */
  70         void setContact (final Contact contact);
  71
  72         /**
  73          * Getter for user instance
  74          * <p>
  75          * @return User instance
  76          */
  77         User getUser ();
  78
  79         /**
  80          * Setter for user instance
  81          * <p>
  82          * @param user User instance
  83          */
  84         void setUser (final User user);
  85
  86         /**
  87          * Getter for dialable mobile number
  88          * <p>
  89          * @return Dialable mobile number
  90          */
  91         DialableMobileNumber getMobileNumber ();
  92
  93         /**
  94          * Setter for dialable mobile number
  95          * <p>
  96          * @param mobileNumber Dialable mobile number
  97          */
  98         void setMobileNumber (final DialableMobileNumber mobileNumber);
  99
 100         /**
 101          * Getter for dialable land-line number
 102          * <p>
 103          * @return Dialable land-line number
 104          */
 105         DialableLandLineNumber getLandLineNumber ();
 106
 107         /**
 108          * Setter for dialable land-line number
 109          * <p>
 110          * @param landLine Dialable land-line number
 111          */
 112         void setLandLineNumber (final DialableLandLineNumber landLine);
 113
 114         /**
 115          * Getter for dialable fax number
 116          * <p>
 117          * @return Dialable fax number
 118          */
 119         DialableFaxNumber getFaxNumber ();
 120
 121         /**
 122          * Setter for dialable fax number
 123          * <p>
 124          * @param faxNumber Dialable fax number
 125          */
 126         void setFaxNumber (final DialableFaxNumber faxNumber);
 127
 128 }