src/java/org/mxchange/pizzaapplication/beans/phone/PizzaAdminPhoneWebRequestController.java

   1 /*
   2  * Copyright (C) 2016 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.phone;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import javax.ejb.Local;
  22 import org.mxchange.jcountry.data.Country;
  23 import org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber;
  24 import org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber;
  25 import org.mxchange.jphone.phonenumbers.mobile.DialableMobileNumber;
  26 import org.mxchange.jphone.phonenumbers.mobileprovider.MobileProvider;
  27
  28 /**
  29  * An interface for a request web controller (bean) for administrative phone
  30  * number purposes.
  31  * <p>
  32  * @author Roland Häder<roland@mxchange.org>
  33  */
  34 @Local
  35 public interface PizzaAdminPhoneWebRequestController extends Serializable {
  36
  37         /**
  38          * Returns a list of all unused ("non-linked") mobile numbers
  39          * <p>
  40          * @return List with all unused mobile numbers
  41          */
  42         List<DialableMobileNumber> allNonLinkedMobileNumbers ();
  43
  44         /**
  45          * Returns a list of all unused ("non-linked") land-line numbers
  46          * <p>
  47          * @return List with all unused land-line numbers
  48          */
  49         List<DialableFaxNumber> allNonLinkedFaxNumbers ();
  50
  51         /**
  52          * Returns a list of all unused ("non-linked") land-line numbers
  53          * <p>
  54          * @return List with all unused land-line numbers
  55          */
  56         List<DialableLandLineNumber> allNonLinkedLandLineNumbers ();
  57
  58         /**
  59          * Deletes given fax entry data
  60          * <p>
  61          * @param faxNumber Fax number to delete
  62          * <p>
  63          * @return Redirect outcome
  64          */
  65         String deleteFaxData (final DialableFaxNumber faxNumber);
  66
  67         /**
  68          * Changes fax entry data
  69          * <p>
  70          * @param faxNumber Fax number to change data
  71          * <p>
  72          * @return Redirect outcome
  73          */
  74         String editFaxData (final DialableFaxNumber faxNumber);
  75
  76         /**
  77          * Deletes given land-line entry data
  78          * <p>
  79          * @param landLineNumber Land-line number to delete
  80          * <p>
  81          * @return Redirect outcome
  82          */
  83         String deleteLandLineData (final DialableLandLineNumber landLineNumber);
  84
  85         /**
  86          * Changes land-line entry data
  87          * <p>
  88          * @param landLineNumber Land-line number to change data
  89          * <p>
  90          * @return Redirect outcome
  91          */
  92         String editLandLineData (final DialableLandLineNumber landLineNumber);
  93
  94         /**
  95          * Deletes given mobile entry data
  96          * <p>
  97          * @param mobileNumber Mobile number to delete
  98          * <p>
  99          * @return Redirect outcome
 100          */
 101         String deleteMobileData (final DialableMobileNumber mobileNumber);
 102
 103         /**
 104          * Changes mobile entry data
 105          * <p>
 106          * @param mobileNumber Mobile number to change data
 107          * <p>
 108          * @return Redirect outcome
 109          */
 110         String editMobileData (final DialableMobileNumber mobileNumber);
 111
 112         /**
 113          * Getter for mobile provider
 114          * <p>
 115          * @return Mobile provider
 116          */
 117         MobileProvider getMobileProvider ();
 118
 119         /**
 120          * Setter for mobile provider
 121          * <p>
 122          * @param mobileProvider Mobile provider
 123          */
 124         void setMobileProvider (final MobileProvider mobileProvider);
 125
 126         /**
 127          * Getter for choosen fax number
 128          * <p>
 129          * @return Choosen fax number
 130          */
 131         DialableFaxNumber getChoosenFaxNumber ();
 132
 133         /**
 134          * Setter for choosen fax number
 135          * <p>
 136          * @param choosenFaxNumber Choosen fax number
 137          */
 138         void setFaxNumber (final DialableFaxNumber choosenFaxNumber);
 139
 140         /**
 141          * Getter for choosen land-line number
 142          * <p>
 143          * @return Choosen land-line number
 144          */
 145         DialableLandLineNumber getChoosenLandLineNumber ();
 146
 147         /**
 148          * Setter for choosen land-line number
 149          * <p>
 150          * @param choosenLandLineNumber Choosen land-line number
 151          */
 152         void setLandLineNumber (final DialableLandLineNumber choosenLandLineNumber);
 153
 154         /**
 155          * Getter for choosen mobile number
 156          * <p>
 157          * @return Choosen mobile number
 158          */
 159         DialableMobileNumber getChoosenMobileNumber ();
 160
 161         /**
 162          * Setter for choosen mobile number
 163          * <p>
 164          * @param choosenMobileNumber Choosen mobile number
 165          */
 166         void setMobileNumber (final DialableMobileNumber choosenMobileNumber);
 167
 168         /**
 169          * Getter for phone area code
 170          * <p>
 171          * @return Phone area code
 172          */
 173         Integer getPhoneAreaCode ();
 174
 175         /**
 176          * Setter for phone area code
 177          * <p>
 178          * @param phoneAreaCode Phone area code
 179          */
 180         void setPhoneAreaCode (final Integer phoneAreaCode);
 181
 182         /**
 183          * Getter for phone country (for dial prefix)
 184          * <p>
 185          * @return Phone country
 186          */
 187         Country getPhoneCountry ();
 188
 189         /**
 190          * Setter for phone country (for dial prefix)
 191          * <p>
 192          * @param phoneCountry Phone country
 193          */
 194         void setPhoneCountry (final Country phoneCountry);
 195
 196         /**
 197          * Getter for dial number without prefix
 198          * <p>
 199          * @return Dial number without prefix
 200          */
 201         Long getPhoneNumber ();
 202
 203         /**
 204          * Setter for dial number without prefix
 205          * <p>
 206          * @param phoneNumber Dial number without prefix
 207          */
 208         void setPhoneNumber (final Long phoneNumber);
 209
 210 }