src/org/mxchange/jcountry/model/data/Country.java

   1 /*
   2  * Copyright (C) 2016 - 2022 Free Software Foundation
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (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 General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jcountry.model.data;
  18
  19 import java.io.Serializable;
  20 import java.util.Date;
  21
  22 /**
  23  * A POJI for country data such as dial prefixes
  24  * <p>
  25  * @author Roland Häder<roland@mxchange.org>
  26  */
  27 public interface Country extends Comparable<Country>, Serializable {
  28
  29         /**
  30          * Getter for country code (example: 49 for Germany, 63 for Philippines)
  31          * <p>
  32          * @return Dial number without prefix
  33          */
  34         Short getCountryPhoneCode ();
  35
  36         /**
  37          * Setter for country code (example: 49 for Germany, 63 for Philippines)
  38          * <p>
  39          * @param countryPhoneCode Country code
  40          */
  41         void setCountryPhoneCode (final Short countryPhoneCode);
  42
  43         /**
  44          * Getter for id number
  45          * <p>
  46          * @return Id number
  47          */
  48         Long getCountryId ();
  49
  50         /**
  51          * Setter for id number
  52          * <p>
  53          * @param countryId Id number
  54          */
  55         void setCountryId (final Long countryId);
  56
  57         /**
  58          * Getter for 2-characters country code
  59          * <p>
  60          * @return Country code
  61          */
  62         String getCountryCode ();
  63
  64         /**
  65          * Setter for 2-characters country code
  66          * <p>
  67          * @param countryCode Country code
  68          */
  69         void setCountryCode (final String countryCode);
  70
  71         /**
  72          * Getter for local dial prefix
  73          * <p>
  74          * @return Local dial prefix
  75          */
  76         String getCountryExternalDialPrefix ();
  77
  78         /**
  79          * Setter for local dial prefix
  80          * <p>
  81          * @param countryExternalDialPrefix Local dial prefix
  82          */
  83         void setCountryExternalDialPrefix (final String countryExternalDialPrefix);
  84
  85         /**
  86          * Getter for abroad dial prefix
  87          * <p>
  88          * @return Abroad dial prefix
  89          */
  90         String getCountryAbroadDialPrefix ();
  91
  92         /**
  93          * Setter for abroad dial prefix
  94          * <p>
  95          * @param countryAbroadDialPrefix Abroad dial prefix
  96          */
  97         void setCountryAbroadDialPrefix (final String countryAbroadDialPrefix);
  98
  99         /**
 100          * Getter for i18n key for country name
 101          * <p>
 102          * @return i18n key for country name
 103          */
 104         String getCountryI18nKey ();
 105
 106         /**
 107          * Setter for i18n key for country name
 108          * <p>
 109          * @param countryI18nKey i18n key for country name
 110          */
 111         void setCountryI18nKey (final String countryI18nKey);
 112
 113         /**
 114          * Getter for whether the local dial prefix is required for local calls
 115          * <p>
 116          * @return Whether the local dial prefix is required
 117          */
 118         Boolean getCountryIsLocalPrefixRequired ();
 119
 120         /**
 121          * Setter for whether the local dial prefix is required for local calls
 122          * <p>
 123          * @param countryIsLocalPrefixRequired Whether the local dial prefix is
 124          *                                     required
 125          */
 126         void setCountryIsLocalPrefixRequired (final Boolean countryIsLocalPrefixRequired);
 127
 128         /**
 129          * Getter for country entry created timestamp
 130          * <p>
 131          * @return Country entry created timestamp
 132          */
 133         Date getCountryEntryCreated ();
 134
 135         /**
 136          * Setter for country entry created timestamp
 137          * <p>
 138          * @param countryEntryCreated Country entry created timestamp
 139          */
 140         void setCountryEntryCreated (final Date countryEntryCreated);
 141
 142         /**
 143          * Getter for country entry updated timestamp
 144          * <p>
 145          * @return Country entry updated timestamp
 146          */
 147         Date getCountryEntryUpdated ();
 148
 149         /**
 150          * Setter for country entry updated timestamp
 151          * <p>
 152          * @param countryEntryUpdated Country entry updated timestamp
 153          */
 154         void setCountryEntryUpdated (final Date countryEntryUpdated);
 155
 156         @Override
 157         boolean equals (final Object object);
 158
 159         @Override
 160         int hashCode ();
 161
 162 }