src/java/org/mxchange/jjobs/beans/country/JobsAdminCountryWebRequestController.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.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 JobsAdminCountryWebRequestController 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. A redirect
  39          * should happen after successfull creation.
  40          * <p>
  41          * @return Redirect outcome
  42          */
  43         String addCountry ();
  44
  45         /**
  46          * Checks whether countries has been registered
  47          * <p>
  48          * @return Whether countries has been registered
  49          */
  50         boolean hasCountries ();
  51
  52         /**
  53          * Getter for abroad dial prefix
  54          * <p>
  55          * @return Abroad dial prefix
  56          */
  57         String getCountryAbroadDialPrefix ();
  58
  59         /**
  60          * Setter for abroad dial prefix
  61          * <p>
  62          * @param countryAbroadDialPrefix Abroad dial prefix
  63          */
  64         void setCountryAbroadDialPrefix (final String countryAbroadDialPrefix);
  65
  66         /**
  67          * Getter for 2-characters country code
  68          * <p>
  69          * @return Country code
  70          */
  71         String getCountryCode ();
  72
  73         /**
  74          * Setter for 2-characters country code
  75          * <p>
  76          * @param countryCode Country code
  77          */
  78         void setCountryCode (final String countryCode);
  79
  80         /**
  81          * Getter for i18n key for country name
  82          * <p>
  83          * @return i18n key for country name
  84          */
  85         String getCountryI18nKey ();
  86
  87         /**
  88          * Setter for i18n key for country name
  89          * <p>
  90          * @param countryI18nKey i18n key for country name
  91          */
  92         void setCountryI18nKey (final String countryI18nKey);
  93
  94         /**
  95          * Getter for whether the local dial prefix is required for local calls
  96          * <p>
  97          * @return Whether the local dial prefix is required
  98          */
  99         Boolean getCountryIsLocalPrefixRequired ();
 100
 101         /**
 102          * Setter for whether the local dial prefix is required for local calls
 103          * <p>
 104          * @param countryIsLocalPrefixRequired Whether the local dial prefix is
 105          * required
 106          */
 107         void setCountryIsLocalPrefixRequired (final Boolean countryIsLocalPrefixRequired);
 108
 109         /**
 110          * Getter for external dial prefix
 111          * <p>
 112          * @return External dial prefix
 113          */
 114         String getCountryExternalDialPrefix ();
 115
 116         /**
 117          * Setter for external dial prefix
 118          * <p>
 119          * @param countryExternalDialPrefix External dial prefix
 120          */
 121         void setCountryExternalDialPrefix (final String countryExternalDialPrefix);
 122
 123         /**
 124          * Getter for country code (example: 49 for Germany, 63 for Philippines)
 125          * <p>
 126          * @return Dial number without prefix
 127          */
 128         Short getCountryPhoneCode ();
 129
 130         /**
 131          * Setter for country code (example: 49 for Germany, 63 for Philippines)
 132          * <p>
 133          * @param countryPhoneCode Country code
 134          */
 135         void setCountryPhoneCode (final Short countryPhoneCode);
 136
 137 }