src/java/org/mxchange/pizzaapplication/beans/helper/PizzaAdminWebRequestController.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.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.jusercore.model.user.User;
  23
  24 /**
  25  * An interface for general bean helper
  26  * <p>
  27  * @author Roland Haeder<roland@mxchange.org>
  28  */
  29 public interface PizzaAdminWebRequestController extends Serializable {
  30
  31         /**
  32          * Getter for user instance
  33          * <p>
  34          * @return User instance
  35          */
  36         User getUser ();
  37
  38         /**
  39          * Setter for user instance
  40          * <p>
  41          * @param user User instance
  42          */
  43         void setUser (final User user);
  44
  45         /**
  46          * Copies currently set user instance's data to adminUserController
  47          */
  48         void copyUserToController ();
  49
  50         /**
  51          * Returns a message key depending on if this contact is a user and/or a
  52          * contact. If this contact is unused, a default key is returned.
  53          * <p>
  54          * @param contact Contact instance to check
  55          * <p>
  56          * @return Message key
  57          */
  58         String getUserCustomerUsageMessageKey (final Contact contact);
  59
  60         /**
  61          * Getter for contact instance
  62          * <p>
  63          * @return Contact instance
  64          */
  65         Contact getContact ();
  66
  67         /**
  68          * Setter for contact instance
  69          * <p>
  70          * @param contact Contact instance
  71          */
  72         void setContact (final Contact contact);
  73
  74         /**
  75          * Getter for customer instance
  76          * <p>
  77          * @return Customer instance
  78          */
  79         Customer getCustomer ();
  80
  81         /**
  82          * Setter for customer instance
  83          * <p>
  84          * @param customer Contact instance
  85          */
  86         void setCustomer (final Customer customer);
  87
  88         /**
  89          * Copies currently set contact instance's data to adminContactController
  90          */
  91         void copyContactToController ();
  92
  93         /**
  94          * Copies currently set customer instance's data to adminCustomerController
  95          */
  96         void copyCustomerToController ();
  97
  98 }