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