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