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.addressbook.facade.contact;
19 import java.io.IOException;
20 import java.lang.reflect.InvocationTargetException;
21 import java.sql.SQLException;
22 import org.mxchange.jcontacts.contact.Contact;
23 import org.mxchange.jcontacts.contact.gender.Gender;
24 import org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException;
25 import org.mxchange.jcore.facade.Facade;
28 * An interface for addressbook contact manager
30 * @author Roland Haeder
32 public interface ContactFacade extends Facade {
35 * Adds given Contact instance to list
37 * @param contact Contact instance to add
38 * @throws org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException If the contact is already added
40 public void addContact (final Contact contact) throws ContactAlreadyAddedException;
43 * Let the user add a new other address
45 public void doAddOtherAddress ();
48 * The user can change address data, like street, ZIP code, city and country
49 * of given Contact instance.
51 * @param contact Instance to change data
53 public void doChangeAddressData (final Contact contact);
56 * The user can change name data, like gender, surname, family name and
57 * company name (if business contact).
59 * @param contact Instance to change data
61 public void doChangeNameData (final Contact contact);
64 * Let the user change other address
66 public void doChangeOtherAddress ();
69 * The user can change other data, like phone numbers or comments.
71 * @param contact Instance to change data
73 public void doChangeOtherData (final Contact contact);
76 * Let the user change own data
78 * @throws java.sql.SQLException If an SQL error occurs
79 * @throws java.io.IOException If an IO error occurs
80 * @throws java.lang.NoSuchMethodException If a method cannot be found
81 * @throws java.lang.IllegalAccessException If a method is not accessible
82 * @throws java.lang.reflect.InvocationTargetException Any other problems?
84 public void doChangeOwnData () throws IOException, SQLException, NoSuchMethodException, IllegalAccessException, InvocationTargetException;
87 * Let the user delete other address
89 public void doDeleteOtherAddress ();
92 * Asks user for own data
94 * @throws org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException If own contact is already added
95 * @throws java.io.IOException If an IO error was found
97 public void doEnterOwnData () throws ContactAlreadyAddedException, IOException;
102 public void doListContacts ();
105 * Searches address book for a contact
107 public void doSearchContacts ();
110 * Allows the user to enter own cellphone number.
112 * @return Cellphone number
114 public String enterOwnCellNumber ();
117 * Allows the user to enter own city name.
121 public String enterOwnCity ();
124 * Allows the user to enter comment for own entry.
128 public String enterOwnComment ();
131 * Allows the user to enter own company name.
133 * @return Company name
135 public String enterOwnCompanyName ();
138 * Allows the user to enter own country code.
140 * @return Country code
142 public String enterOwnCountryCode ();
145 * Allows the user to enter own email address.
147 * @return Email address
149 public String enterOwnEmailAddress ();
152 * Allows the user to enter own family name.
154 * @return Family name
156 public String enterOwnFamilyName ();
159 * Allows the user to enter own fax number.
163 public String enterOwnFaxNumber ();
166 * Allows the user to enter own surname.
170 public String enterOwnFirstName ();
173 * Allows the user to enter own gender.
177 public Gender enterOwnGender ();
180 * Allows the user to enter own phone number.
182 * @return Phone number
184 public String enterOwnPhoneNumber ();
187 * Allows the user to enter own street and house number.
189 * @return Street and house number
191 public String enterOwnStreet ();
194 * Allows the user to enter own ZIP code.
198 public int enterOwnZipCode ();
201 * Getter for column count
203 * @return Column count TODO: This is needed for TableModel in Swing
205 public int getColumnCount ();
208 * Getter for column name at given index.
210 * @param columnIndex Column index
211 * @return Database column name TODO: This is needed for TableModel in Swing
213 public String getColumnName (final int columnIndex);
216 * Getter for translated column name at given index.
218 * @param columnIndex Column index
219 * @return Human-readable column name TODO: This is needed for TableModel in
222 public String getTranslatedColumnName (final int columnIndex);
225 * Somewhat "getter" for value from given row and column index
227 * @param rowIndex Row index
228 * @param columnIndex Column index
229 * @return Value from given row/column
230 * @throws java.lang.NoSuchMethodException If the method was not found
231 * @throws java.lang.IllegalAccessException If the accessed method was not public
232 * @throws java.lang.reflect.InvocationTargetException Something else
233 * happened? TODO: This is needed for TableModel in Swing
235 public Object getValueFromRowColumn (final int rowIndex, final int columnIndex) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException;
238 * Checks whether own contact is already added by checking all entries for
241 * @return Whether own contact is already added
242 * @throws java.io.IOException If an IO error occurs
244 public boolean isOwnContactAdded () throws IOException;
247 * Adds given contact to address book
249 * @param contact Contact being added TODO Add check for book size
251 public void registerContact (final Contact contact);