src/java/org/mxchange/jjobs/beans/mobileprovider/JobsAdminMobileProviderWebRequestController.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.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 JobsAdminMobileProviderWebRequestController 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. A redirect should take place after successfull creation.
  36          * <p>
  37          * @return Redirect outcome
  38          */
  39         String addMobileProvider ();
  40
  41         /**
  42          * Returns a list of all mobile providers
  43          * <p>
  44          * @return A list of all mobile providers
  45          */
  46         List<MobileProvider> allMobileProvider ();
  47
  48         /**
  49          * Checks whether mobile providers are registered
  50          * <p>
  51          * @return Whether mobile providers are registered
  52          */
  53         boolean hasMobileProvider ();
  54
  55         /**
  56          * Getter for provider dial prefix
  57          * <p>
  58          * @return Provider dial prefix
  59          */
  60         Long getProviderDialPrefix ();
  61
  62         /**
  63          * Setter for provider dial prefix
  64          * <p>
  65          * @param providerDialPrefix Provider dial prefix
  66          */
  67         void setProviderDialPrefix (final Long providerDialPrefix);
  68
  69         /**
  70          * Getter for provider name
  71          * <p>
  72          * @return Provider name
  73          */
  74         String getProviderName ();
  75
  76         /**
  77          * Setter for provider name
  78          * <p>
  79          * @param providerName Provider name
  80          */
  81         void setProviderName (final String providerName);
  82
  83         /**
  84          * Getter for country instance ('s dial data)
  85          * <p>
  86          * @return Country instance
  87          */
  88         Country getProviderCountry ();
  89
  90         /**
  91          * Setter for country instance ('s dial data)
  92          * <p>
  93          * @param country Country instance
  94          */
  95         void setProviderCountry (final Country country);
  96
  97         /**
  98          * Getter for pattern for mail gateway
  99          * <p>
 100          * @return Pattern for mail gateway
 101          */
 102         String getProviderMailPattern ();
 103
 104         /**
 105          * Setter for pattern for mail gateway
 106          * <p>
 107          * @param providerMailPattern Pattern for mail gateway
 108          */
 109         void setProviderMailPattern (final String providerMailPattern);
 110
 111 }