src/java/org/mxchange/addressbook/beans/country/AddressbookAdminCountryWebRequestController.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.country;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import org.mxchange.jcountry.data.Country;
  22
  23 /**
  24  * An interface for administrative country beans
  25  * <p>
  26  * @author Roland Haeder<roland@mxchange.org>
  27  */
  28 public interface AddressbookAdminCountryWebRequestController extends Serializable {
  29
  30         /**
  31          * A list of all countries
  32          * <p>
  33          * @return All countries
  34          */
  35         List<Country> allCountries ();
  36
  37         /**
  38          * Adds country to all relevant beans and sends it to the EJB.
  39          */
  40         void addCountry ();
  41
  42         /**
  43          * Checks whether countries has been registered
  44          * <p>
  45          * @return Whether countries has been registered
  46          */
  47         boolean hasCountries ();
  48
  49         /**
  50          * Getter for abroad dial prefix
  51          * <p>
  52          * @return Abroad dial prefix
  53          */
  54         String getCountryAbroadDialPrefix ();
  55
  56         /**
  57          * Setter for abroad dial prefix
  58          * <p>
  59          * @param countryAbroadDialPrefix Abroad dial prefix
  60          */
  61         void setCountryAbroadDialPrefix (final String countryAbroadDialPrefix);
  62
  63         /**
  64          * Getter for 2-characters country code
  65          * <p>
  66          * @return Country code
  67          */
  68         String getCountryCode ();
  69
  70         /**
  71          * Setter for 2-characters country code
  72          * <p>
  73          * @param countryCode Country code
  74          */
  75         void setCountryCode (final String countryCode);
  76
  77         /**
  78          * Getter for i18n key for country name
  79          * <p>
  80          * @return i18n key for country name
  81          */
  82         String getCountryI18nKey ();
  83
  84         /**
  85          * Setter for i18n key for country name
  86          * <p>
  87          * @param countryI18nKey i18n key for country name
  88          */
  89         void setCountryI18nKey (final String countryI18nKey);
  90
  91         /**
  92          * Getter for whether the local dial prefix is required for local calls
  93          * <p>
  94          * @return Whether the local dial prefix is required
  95          */
  96         Boolean getCountryIsLocalPrefixRequired ();
  97
  98         /**
  99          * Setter for whether the local dial prefix is required for local calls
 100          * <p>
 101          * @param countryIsLocalPrefixRequired Whether the local dial prefix is
 102          *                                     required
 103          */
 104         void setCountryIsLocalPrefixRequired (final Boolean countryIsLocalPrefixRequired);
 105
 106         /**
 107          * Getter for external dial prefix
 108          * <p>
 109          * @return External dial prefix
 110          */
 111         String getCountryExternalDialPrefix ();
 112
 113         /**
 114          * Setter for external dial prefix
 115          * <p>
 116          * @param countryExternalDialPrefix External dial prefix
 117          */
 118         void setCountryExternalDialPrefix (final String countryExternalDialPrefix);
 119
 120         /**
 121          * Getter for country code (example: 49 for Germany, 63 for Philippines)
 122          * <p>
 123          * @return Dial number without prefix
 124          */
 125         Short getCountryPhoneCode ();
 126
 127         /**
 128          * Setter for country code (example: 49 for Germany, 63 for Philippines)
 129          * <p>
 130          * @param countryPhoneCode Country code
 131          */
 132         void setCountryPhoneCode (final Short countryPhoneCode);
 133
 134 }