src/org/mxchange/addressbook/contact/Contact.java

   1 /*\r
   2  * Copyright (C) 2015 Roland Haeder\r
   3  *\r
   4  * This program is free software: you can redistribute it and/or modify\r
   5  * it under the terms of the GNU General Public License as published by\r
   6  * the Free Software Foundation, either version 3 of the License, or\r
   7  * (at your option) any later version.\r
   8  *\r
   9  * This program is distributed in the hope that it will be useful,\r
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  12  * GNU General Public License for more details.\r
  13  *\r
  14  * You should have received a copy of the GNU General Public License\r
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
  16  */\r
  17 package org.mxchange.addressbook.contact;\r
  18 \r
  19 import org.mxchange.addressbook.FrameworkInterface;\r
  20 import org.mxchange.addressbook.client.Client;\r
  21 \r
  22 /**\r
  23  *\r
  24  * @author Roland Haeder\r
  25  */\r
  26 public interface Contact extends FrameworkInterface {\r
  27 \r
  28     /**\r
  29      * Some "getter" for translated gender of the contact\r
  30      * @return Translated / human-readable gender\r
  31      */\r
  32     public String getTranslatedGender();\r
  33 \r
  34     /**\r
  35      * Checks whether the contact is user's own data\r
  36      *\r
  37      * @return Own data?\r
  38      */\r
  39     public boolean isOwnContact();\r
  40 \r
  41     /**\r
  42      * Gender of the contact\r
  43      *\r
  44      * @return the gender\r
  45      */\r
  46     public char getGender();\r
  47 \r
  48     /**\r
  49      * Surname\r
  50      *\r
  51      * @return the surname\r
  52      */\r
  53     public String getSurname();\r
  54 \r
  55     /**\r
  56      * Family name\r
  57      *\r
  58      * @return the familyName\r
  59      */\r
  60     public String getFamilyName();\r
  61 \r
  62     /**\r
  63      * Companyname\r
  64      *\r
  65      * @return the companyName\r
  66      */\r
  67     public String getCompanyName();\r
  68 \r
  69     /**\r
  70      * Street\r
  71      *\r
  72      * @return the street\r
  73      */\r
  74     public String getStreet();\r
  75 \r
  76     /**\r
  77      * House number\r
  78      *\r
  79      * @return the houseNumber\r
  80      */\r
  81     public int getHouseNumber();\r
  82 \r
  83     /**\r
  84      * ZIP code\r
  85      *\r
  86      * @return the zipCode\r
  87      */\r
  88     public long getZipCode();\r
  89 \r
  90     /**\r
  91      * City\r
  92      *\r
  93      * @return the city\r
  94      */\r
  95     public String getCity();\r
  96 \r
  97     /**\r
  98      * Country code\r
  99      *\r
 100      * @return the countryCode\r
 101      */\r
 102     public String getCountryCode();\r
 103 \r
 104     /**\r
 105      * Email address\r
 106      *\r
 107      * @return the emailAddress\r
 108      */\r
 109     public String getEmailAddress();\r
 110 \r
 111     /**\r
 112      * Phone number\r
 113      *\r
 114      * @return the phoneNumber\r
 115      */\r
 116     public String getPhoneNumber();\r
 117 \r
 118     /**\r
 119      * Fax number\r
 120      *\r
 121      * @return the faxNumber\r
 122      */\r
 123     public String getFaxNumber();\r
 124 \r
 125     /**\r
 126      * Cellphone number\r
 127      *\r
 128      * @return the cellphoneNumber\r
 129      */\r
 130     public String getCellphoneNumber();\r
 131 \r
 132     /**\r
 133      * Birth day\r
 134      *\r
 135      * @return the birthday\r
 136      */\r
 137     public String getBirthday();\r
 138 \r
 139     /**\r
 140      * Comments\r
 141      *\r
 142      * @return the comment\r
 143      */\r
 144     public String getComment();\r
 145 \r
 146     /**\r
 147      * Shows the contact to the user\r
 148      *\r
 149      * @param client Client instance to call back\r
 150      */\r
 151     public void show (final Client client);\r
 152 \r
 153     /**\r
 154      * Updates address data in this Contact instance\r
 155      * \r
 156      * @param street Street\r
 157      * @param zipCode ZIP code\r
 158      * @param city City\r
 159      * @param countryCode Country code\r
 160      */\r
 161     public void updateAddressData (final String street, final long zipCode, final String city, final String countryCode);\r
 162 \r
 163     /**\r
 164      * Updates name data in this Contact instance\r
 165      * \r
 166      * @param gender Gender (M, F, C)\r
 167      * @param surname Surname\r
 168      * @param familyName Family name\r
 169      * @param companyName Company name\r
 170      */\r
 171     public void updateNameData (final char gender, final String surname, final String familyName, final String companyName);\r
 172 \r
 173     /**\r
 174      * Updates other data in this Contact instance\r
 175      * \r
 176      * @param phoneNumber Phone number\r
 177      * @param cellNumber Cellphone number\r
 178      * @param faxNumber Fax number\r
 179      * @param email Email address\r
 180      * @param birthday Birthday\r
 181      * @param comment Comments\r
 182      */\r
 183     public void updateOtherData (final String phoneNumber, final String cellNumber, final String faxNumber, final String email, final String birthday, final String comment);\r
 184 }\r