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