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