src/java/org/mxchange/jjobs/beans/phone/JobsAdminPhoneWebRequestController.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.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 Haeder<roland@mxchange.org>
  33  */
  34 @Local
  35 public interface JobsAdminPhoneWebRequestController 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 mobile entry data
  60          * <p>
  61          * @param mobileNumber Mobile number to delete
  62          * <p>
  63          * @return Redirect outcome
  64          */
  65         String deleteMobileData (final DialableMobileNumber mobileNumber);
  66
  67         /**
  68          * Changes mobile entry data
  69          * <p>
  70          * @param mobileNumber Mobile number to change data
  71          * <p>
  72          * @return Redirect outcome
  73          */
  74         String editMobileData (final DialableMobileNumber mobileNumber);
  75
  76         /**
  77          * Getter for mobile provider
  78          * <p>
  79          * @return Mobile provider
  80          */
  81         MobileProvider getMobileProvider ();
  82
  83         /**
  84          * Setter for mobile provider
  85          * <p>
  86          * @param mobileProvider Mobile provider
  87          */
  88         void setMobileProvider (final MobileProvider mobileProvider);
  89
  90         /**
  91          * Getter for choosen fax number
  92          * <p>
  93          * @return Choosen fax number
  94          */
  95         DialableFaxNumber getChoosenFaxNumber ();
  96
  97         /**
  98          * Setter for choosen fax number
  99          * <p>
 100          * @param choosenFaxNumber Choosen fax number
 101          */
 102         void setChoosenFaxNumber (final DialableFaxNumber choosenFaxNumber);
 103
 104         /**
 105          * Getter for choosen land-line number
 106          * <p>
 107          * @return Choosen land-line number
 108          */
 109         DialableLandLineNumber getChoosenLandLineNumber ();
 110
 111         /**
 112          * Setter for choosen land-line number
 113          * <p>
 114          * @param choosenLandLineNumber Choosen land-line number
 115          */
 116         void setChoosenLandLineNumber (final DialableLandLineNumber choosenLandLineNumber);
 117
 118         /**
 119          * Getter for choosen mobile number
 120          * <p>
 121          * @return Choosen mobile number
 122          */
 123         DialableMobileNumber getChoosenMobileNumber ();
 124
 125         /**
 126          * Setter for choosen mobile number
 127          * <p>
 128          * @param choosenMobileNumber Choosen mobile number
 129          */
 130         void setChoosenMobileNumber (final DialableMobileNumber choosenMobileNumber);
 131
 132         /**
 133          * Getter for phone area code
 134          * <p>
 135          * @return Phone area code
 136          */
 137         Integer getPhoneAreaCode ();
 138
 139         /**
 140          * Setter for phone area code
 141          * <p>
 142          * @param phoneAreaCode Phone area code
 143          */
 144         void setPhoneAreaCode (final Integer phoneAreaCode);
 145
 146         /**
 147          * Getter for phone country (for dial prefix)
 148          * <p>
 149          * @return Phone country
 150          */
 151         Country getPhoneCountry ();
 152
 153         /**
 154          * Setter for phone country (for dial prefix)
 155          * <p>
 156          * @param phoneCountry Phone country
 157          */
 158         void setPhoneCountry (final Country phoneCountry);
 159
 160         /**
 161          * Getter for dial number without prefix
 162          * <p>
 163          * @return Dial number without prefix
 164          */
 165         Long getPhoneNumber ();
 166
 167         /**
 168          * Setter for dial number without prefix
 169          * <p>
 170          * @param phoneNumber Dial number without prefix
 171          */
 172         void setPhoneNumber (final Long phoneNumber);
 173
 174 }