src/java/org/mxchange/addressbook/beans/mobileprovider/AddressbookAdminMobileProviderWebRequestController.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.addressbook.beans.mobileprovider;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import org.mxchange.jcountry.data.Country;
  22 import org.mxchange.jphone.phonenumbers.mobileprovider.MobileProvider;
  23
  24 /**
  25  * An interface for a request web controller (bean) for administrative mobile
  26  * provider purposes.
  27  * <p>
  28  * @author Roland Haeder<roland@mxchange.org>
  29  */
  30 public interface AddressbookAdminMobileProviderWebRequestController extends Serializable {
  31
  32         /**
  33          * Adds a mobile provider to database by calling the EJB. A pre-check on
  34          * dial-prefix and country combination is done, if found, an exception is
  35          * thrown.
  36          */
  37         void addMobileProvider ();
  38
  39         /**
  40          * Returns a list of all mobile providers
  41          * <p>
  42          * @return A list of all mobile providers
  43          */
  44         List<MobileProvider> allMobileProvider ();
  45
  46         /**
  47          * Checks whether mobile providers are registered
  48          * <p>
  49          * @return Whether mobile providers are registered
  50          */
  51         boolean hasMobileProvider ();
  52
  53         /**
  54          * Getter for provider dial prefix
  55          * <p>
  56          * @return Provider dial prefix
  57          */
  58         Long getProviderDialPrefix ();
  59
  60         /**
  61          * Setter for provider dial prefix
  62          * <p>
  63          * @param providerDialPrefix Provider dial prefix
  64          */
  65         void setProviderDialPrefix (final Long providerDialPrefix);
  66
  67         /**
  68          * Getter for provider name
  69          * <p>
  70          * @return Provider name
  71          */
  72         String getProviderName ();
  73
  74         /**
  75          * Setter for provider name
  76          * <p>
  77          * @param providerName Provider name
  78          */
  79         void setProviderName (final String providerName);
  80
  81         /**
  82          * Getter for country instance ('s dial data)
  83          * <p>
  84          * @return Country instance
  85          */
  86         Country getProviderCountry ();
  87
  88         /**
  89          * Setter for country instance ('s dial data)
  90          * <p>
  91          * @param country Country instance
  92          */
  93         void setProviderCountry (final Country country);
  94
  95         /**
  96          * Getter for pattern for mail gateway
  97          * <p>
  98          * @return Pattern for mail gateway
  99          */
 100         String getProviderMailPattern ();
 101
 102         /**
 103          * Setter for pattern for mail gateway
 104          * <p>
 105          * @param providerMailRegex Pattern for mail gateway
 106          */
 107         void setProviderMailPattern (final String providerMailRegex);
 108
 109 }