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