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

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   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.jcore.contact;
  18
  19 import java.lang.reflect.Field;
  20 import java.util.Iterator;
  21 import java.util.Map;
  22 import org.mxchange.jcore.FrameworkInterface;
  23 import org.mxchange.jcore.client.Client;
  24
  25 /**
  26  * A general contact interface
  27  *
  28  * @author Roland Haeder
  29  */
  30 public interface Contact extends FrameworkInterface {
  31         /**
  32          * Returns an iterator of all values from this object
  33          * @return An iterator
  34          */
  35         public Iterator<Map.Entry<Field, Object>> iterator ();
  36
  37         /**
  38          * Some "getter" for translated gender of the contact
  39          *
  40          * @return Translated / human-readable gender
  41          */
  42         public String getTranslatedGender ();
  43
  44         /**
  45          * Gender of the contact
  46          *
  47          * @return the gender
  48          */
  49         public Gender getGender ();
  50
  51         /**
  52          * Gender of the contact
  53          *
  54          * @param gender the gender to set
  55          */
  56         public void setGender (final Gender gender);
  57
  58         /**
  59          * Surname
  60          *
  61          * @return the surname
  62          */
  63         public String getSurname ();
  64
  65         /**
  66          * Surname
  67          *
  68          * @param surname the surname to set
  69          */
  70         public void setSurname (final String surname);
  71
  72         /**
  73          * Family name
  74          *
  75          * @return the familyName
  76          */
  77         public String getFamilyName ();
  78
  79         /**
  80          * Family name
  81          *
  82          * @param familyName the familyName to set
  83          */
  84         public void setFamilyName (final String familyName);
  85
  86         /**
  87          * Companyname
  88          *
  89          * @return the companyName
  90          */
  91         public String getCompanyName ();
  92
  93         /**
  94          * Companyname
  95          *
  96          * @param companyName the companyName to set
  97          */
  98         public void setCompanyName (final String companyName);
  99
 100         /**
 101          * Street
 102          *
 103          * @return the street
 104          */
 105         public String getStreet ();
 106
 107         /**
 108          * Street
 109          *
 110          * @param street the street to set
 111          */
 112         public void setStreet (final String street);
 113
 114         /**
 115          * House number
 116          *
 117          * @return the houseNumber
 118          */
 119         public Long getHouseNumber ();
 120
 121         /**
 122          * House number
 123          *
 124          * @param houseNumber the houseNumber to set
 125          */
 126         public void setHouseNumber (final Long houseNumber);
 127
 128         /**
 129          * ZIP code
 130          *
 131          * @return the zipCode
 132          */
 133         public Long getZipCode ();
 134
 135         /**
 136          * ZIP code
 137          *
 138          * @param zipCode the zipCode to set
 139          */
 140         public void setZipCode (final Long zipCode);
 141
 142         /**
 143          * City
 144          *
 145          * @return the city
 146          */
 147         public String getCity ();
 148
 149         /**
 150          * City
 151          *
 152          * @param city the city to set
 153          */
 154         public void setCity (final String city);
 155
 156         /**
 157          * Country code
 158          *
 159          * @return the countryCode
 160          */
 161         public String getCountryCode ();
 162
 163         /**
 164          * Country code
 165          *
 166          * @param countryCode the countryCode to set
 167          */
 168         public void setCountryCode (final String countryCode);
 169
 170         /**
 171          * Email address
 172          *
 173          * @return the emailAddress
 174          */
 175         public String getEmailAddress ();
 176
 177         /**
 178          * Email address
 179          *
 180          * @param emailAddress the emailAddress to set
 181          */
 182         public void setEmailAddress (final String emailAddress);
 183
 184         /**
 185          * Phone number
 186          *
 187          * @return the phoneNumber
 188          */
 189         public String getPhoneNumber ();
 190
 191         /**
 192          * Phone number
 193          *
 194          * @param phoneNumber the phoneNumber to set
 195          */
 196         public void setPhoneNumber (final String phoneNumber);
 197
 198         /**
 199          * Fax number
 200          *
 201          * @return the faxNumber
 202          */
 203         public String getFaxNumber ();
 204
 205         /**
 206          * Fax number
 207          *
 208          * @param faxNumber the faxNumber to set
 209          */
 210         public void setFaxNumber (final String faxNumber);
 211
 212         /**
 213          * Cellphone number
 214          *
 215          * @return the cellphoneNumber
 216          */
 217         public String getCellphoneNumber ();
 218
 219         /**
 220          * Cellphone number
 221          *
 222          * @param cellphoneNumber the cellphoneNumber to set
 223          */
 224         public void setCellphoneNumber (final String cellphoneNumber);
 225
 226         /**
 227          * Birth day
 228          *
 229          * @return the birthday
 230          */
 231         public String getBirthday ();
 232
 233         /**
 234          * Birth day
 235          *
 236          * @param birthday the birthday to set
 237          */
 238         public void setBirthday (final String birthday);
 239
 240         /**
 241          * Comments
 242          *
 243          * @return the comment
 244          */
 245         public String getComment ();
 246
 247         /**
 248          * Comments
 249          *
 250          * @param comment the comment to set
 251          */
 252         public void setComment (final String comment);
 253
 254         /**
 255          * Checks whether the contact is user's own data
 256          *
 257          * @return Own data?
 258          */
 259         public boolean isOwnContact ();
 260
 261         /**
 262          * Shows the contact to the user
 263          *
 264          * @param client Client instance to call back
 265          */
 266         public void show (final Client client);
 267 }