src/java/org/mxchange/pizzaapplication/beans/helper/PizzaWebRequestHelperController.java

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