src/org/mxchange/jcontacts/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.jcontacts.contact;
  18
  19 import java.io.Serializable;
  20 import java.util.Calendar;
  21 import java.util.Date;
  22 import org.mxchange.jcontacts.contact.gender.Gender;
  23
  24 /**
  25  * A general contact interface
  26  * <p>
  27  * @author Roland Haeder<roland@mxchange.org>
  28  */
  29 public interface Contact extends Serializable {
  30
  31         /**
  32          * Copies all attributes from other contact object to this
  33          * <p>
  34          * @param contact Source instance
  35          */
  36         public void copyAll (final Contact contact);
  37
  38         /**
  39          * Birth day
  40          * <p>
  41          * @return the birthday
  42          */
  43         public Date getBirthday ();
  44
  45         /**
  46          * Birth day
  47          * <p>
  48          * @param birthday the birthday to set
  49          */
  50         public void setBirthday (final Date birthday);
  51
  52         /**
  53          * Cellphone number
  54          * <p>
  55          * @return the cellphoneNumber
  56          */
  57         public String getCellphoneNumber ();
  58
  59         /**
  60          * Cellphone number
  61          * <p>
  62          * @param cellphoneNumber the cellphoneNumber to set
  63          */
  64         public void setCellphoneNumber (final String cellphoneNumber);
  65
  66         /**
  67          * City
  68          * <p>
  69          * @return the city
  70          */
  71         public String getCity ();
  72
  73         /**
  74          * City
  75          * <p>
  76          * @param city the city to set
  77          */
  78         public void setCity (final String city);
  79
  80         /**
  81          * Comments
  82          * <p>
  83          * @return the comment
  84          */
  85         public String getComment ();
  86
  87         /**
  88          * Comments
  89          * <p>
  90          * @param comment the comment to set
  91          */
  92         public void setComment (final String comment);
  93
  94         /**
  95          * Id number
  96          * <p>
  97          * @return the contactId
  98          */
  99         public Long getContactId ();
 100
 101         /**
 102          * Id number
 103          * <p>
 104          * @param id the contactId to set
 105          */
 106         public void setContactId (final Long id);
 107
 108         /**
 109          * Country code
 110          * <p>
 111          * @return the countryCode
 112          */
 113         public String getCountryCode ();
 114
 115         /**
 116          * Country code
 117          * <p>
 118          * @param countryCode the countryCode to set
 119          */
 120         public void setCountryCode (final String countryCode);
 121
 122         /**
 123          * Getter for "created" timestamp
 124          * <p>
 125          * @return "created" timestamp
 126          */
 127         public Calendar getCreated ();
 128
 129         /**
 130          * Setter for "created" timestamp
 131          * <p>
 132          * @param created "created" timestamp
 133          */
 134         public void setCreated (final Calendar created);
 135
 136         /**
 137          * Email address
 138          * <p>
 139          * @return the emailAddress
 140          */
 141         public String getEmailAddress ();
 142
 143         /**
 144          * Email address
 145          * <p>
 146          * @param emailAddress the emailAddress to set
 147          */
 148         public void setEmailAddress (final String emailAddress);
 149
 150         /**
 151          * Family name
 152          * <p>
 153          * @return the familyName
 154          */
 155         public String getFamilyName ();
 156
 157         /**
 158          * Family name
 159          * <p>
 160          * @param familyName the familyName to set
 161          */
 162         public void setFamilyName (final String familyName);
 163
 164         /**
 165          * Fax number
 166          * <p>
 167          * @return the faxNumber
 168          */
 169         public String getFaxNumber ();
 170
 171         /**
 172          * Fax number
 173          * <p>
 174          * @param faxNumber the faxNumber to set
 175          */
 176         public void setFaxNumber (final String faxNumber);
 177
 178         /**
 179          * First name
 180          * <p>
 181          * @return the first name
 182          */
 183         public String getFirstName ();
 184
 185         /**
 186          * First name
 187          * <p>
 188          * @param firstName the first name to set
 189          */
 190         public void setFirstName (final String firstName);
 191
 192         /**
 193          * Gender of the contact
 194          * <p>
 195          * @return the gender
 196          */
 197         public Gender getGender ();
 198
 199         /**
 200          * Gender of the contact
 201          * <p>
 202          * @param gender the gender to set
 203          */
 204         public void setGender (final Gender gender);
 205
 206         /**
 207          * House number
 208          * <p>
 209          * @return the houseNumber
 210          */
 211         public Short getHouseNumber ();
 212
 213         /**
 214          * House number
 215          * <p>
 216          * @param houseNumber the houseNumber to set
 217          */
 218         public void setHouseNumber (final Short houseNumber);
 219
 220         /**
 221          * Setter for own contact
 222          * <p>
 223          * @param ownContact Own contact
 224          */
 225         public void setOwnContact (final Boolean ownContact);
 226
 227         /**
 228          * Phone number
 229          * <p>
 230          * @return the phoneNumber
 231          */
 232         public String getPhoneNumber ();
 233
 234         /**
 235          * Phone number
 236          * <p>
 237          * @param phoneNumber the phoneNumber to set
 238          */
 239         public void setPhoneNumber (final String phoneNumber);
 240
 241         /**
 242          * Street
 243          * <p>
 244          * @return the street
 245          */
 246         public String getStreet ();
 247
 248         /**
 249          * Street
 250          * <p>
 251          * @param street the street to set
 252          */
 253         public void setStreet (final String street);
 254
 255         /**
 256          * Getter for "updated" timestamp
 257          * <p>
 258          * @return "updated" timestamp
 259          */
 260         public Calendar getUpdated ();
 261
 262         /**
 263          * Getter for "updated" timestamp
 264          * <p>
 265          * @param updated "updated" timestamp
 266          */
 267         public void setUpdated (final Calendar updated);
 268
 269         /**
 270          * ZIP code
 271          * <p>
 272          * @return the zipCode
 273          */
 274         public Integer getZipCode ();
 275
 276         /**
 277          * ZIP code
 278          * <p>
 279          * @param zipCode the zipCode to set
 280          */
 281         public void setZipCode (final Integer zipCode);
 282
 283         /**
 284          * Checks whether the contact is user's own data
 285          * <p>
 286          * @return Own data?
 287          */
 288         public Boolean isOwnContact ();
 289 }