src/org/mxchange/jphone/model/phonenumbers/DialableNumber.java

   1 /*
   2  * Copyright (C) 2016, 2017 Roland Häder
   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.jphone.model.phonenumbers;
  18
  19 import java.io.Serializable;
  20 import java.util.Date;
  21 import org.mxchange.jcountry.model.data.Country;
  22
  23 /**
  24  * A POJI for dial-able numbers
  25  * <p>
  26  * @author Roland Häder<roland@mxchange.org>
  27  */
  28 public interface DialableNumber extends Serializable {
  29
  30         /**
  31          * Getter for country instance ('s dial data)
  32          * <p>
  33          * @return Country instance
  34          */
  35         Country getPhoneCountry ();
  36
  37         /**
  38          * Setter for country instance ('s dial data)
  39          * <p>
  40          * @param country Country instance
  41          */
  42         void setPhoneCountry (final Country country);
  43
  44         /**
  45          * Getter for id number
  46          * <p>
  47          * @return Id number
  48          */
  49         Long getPhoneId ();
  50
  51         /**
  52          * Setter for id number
  53          * <p>
  54          * @param phoneId Id number
  55          */
  56         void setPhoneId (final Long phoneId);
  57
  58         /**
  59          * Getter for dial number without prefix
  60          * <p>
  61          * @return Dial number without prefix
  62          */
  63         Long getPhoneNumber ();
  64
  65         /**
  66          * Setter for dial number without prefix
  67          * <p>
  68          * @param phoneNumber Dial number without prefix
  69          */
  70         void setPhoneNumber (final Long phoneNumber);
  71
  72         /**
  73          * Getter for area code without dial prefix (example: 2151 for Krefeld)
  74          * <p>
  75          * @return Area code without dial prefix
  76          */
  77         Integer getPhoneAreaCode ();
  78
  79         /**
  80          * Setter for area code without dial prefix (example: 2151 for Krefeld)
  81          * <p>
  82          * @param phoneAreaCode Area code without dial prefix
  83          */
  84         void setPhoneAreaCode (final Integer phoneAreaCode);
  85
  86         /**
  87          * Getter for timestamp when this entry has been created
  88          * <p>
  89          * @return Timestamp when this entry has been created
  90          */
  91         Date getPhoneEntryCreated ();
  92
  93         /**
  94          * Setter for timestamp when this entry has been created
  95          * <p>
  96          * @param phoneEntryCreated Timestamp when this entry has been created
  97          */
  98         void setPhoneEntryCreated (final Date phoneEntryCreated);
  99
 100         /**
 101          * Getter for timestamp when this entry has been updated
 102          * <p>
 103          * @return Timestamp when this entry has been updated
 104          */
 105         Date getPhoneEntryUpdated ();
 106
 107         /**
 108          * Setter for timestamp when this entry has been updated
 109          * <p>
 110          * @param phoneEntryUpdated Timestamp when this entry has been updated
 111          */
 112         void setPhoneEntryUpdated (final Date phoneEntryUpdated);
 113
 114 }