2 * Copyright (C) 2015 Roland Haeder
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.
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.
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/>.
17 package org.mxchange.jcore.contact;
19 import java.lang.reflect.Field;
20 import java.util.Iterator;
22 import org.mxchange.jcore.FrameworkInterface;
23 import org.mxchange.jcore.client.Client;
26 * A general contact interface
28 * @author Roland Haeder
30 public interface Contact extends FrameworkInterface {
32 * Returns an iterator of all values from this object
35 public Iterator<Map.Entry<Field, Object>> iterator ();
38 * Some "getter" for translated gender of the contact
40 * @return Translated / human-readable gender
42 public String getTranslatedGender ();
45 * Gender of the contact
49 public Gender getGender ();
52 * Gender of the contact
54 * @param gender the gender to set
56 public void setGender (final Gender gender);
63 public String getSurname ();
68 * @param surname the surname to set
70 public void setSurname (final String surname);
75 * @return the familyName
77 public String getFamilyName ();
82 * @param familyName the familyName to set
84 public void setFamilyName (final String familyName);
89 * @return the companyName
91 public String getCompanyName ();
96 * @param companyName the companyName to set
98 public void setCompanyName (final String companyName);
105 public String getStreet ();
110 * @param street the street to set
112 public void setStreet (final String street);
117 * @return the houseNumber
119 public long getHouseNumber ();
124 * @param houseNumber the houseNumber to set
126 public void setHouseNumber (final long houseNumber);
131 * @return the zipCode
133 public long getZipCode ();
138 * @param zipCode the zipCode to set
140 public void setZipCode (final long zipCode);
147 public String getCity ();
152 * @param city the city to set
154 public void setCity (final String city);
159 * @return the countryCode
161 public String getCountryCode ();
166 * @param countryCode the countryCode to set
168 public void setCountryCode (final String countryCode);
173 * @return the emailAddress
175 public String getEmailAddress ();
180 * @param emailAddress the emailAddress to set
182 public void setEmailAddress (final String emailAddress);
187 * @return the phoneNumber
189 public String getPhoneNumber ();
194 * @param phoneNumber the phoneNumber to set
196 public void setPhoneNumber (final String phoneNumber);
201 * @return the faxNumber
203 public String getFaxNumber ();
208 * @param faxNumber the faxNumber to set
210 public void setFaxNumber (final String faxNumber);
215 * @return the cellphoneNumber
217 public String getCellphoneNumber ();
222 * @param cellphoneNumber the cellphoneNumber to set
224 public void setCellphoneNumber (final String cellphoneNumber);
229 * @return the birthday
231 public String getBirthday ();
236 * @param birthday the birthday to set
238 public void setBirthday (final String birthday);
243 * @return the comment
245 public String getComment ();
250 * @param comment the comment to set
252 public void setComment (final String comment);
255 * Checks whether the contact is user's own data
259 public boolean isOwnContact ();
262 * Shows the contact to the user
264 * @param client Client instance to call back
266 public void show (final Client client);