src/org/mxchange/addressbook/facade/contact/ContactFacade.java

   1 /*
   2  * Copyright (C) 2016, 2020 Free Software Foundation
   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.addressbook.facade.contact;
  18
  19 import java.io.IOException;
  20 import org.mxchange.jcontacts.contact.Contact;
  21 import org.mxchange.jcontacts.contact.title.PersonalTitle;
  22 import org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException;
  23 import org.mxchange.jcontactsbusiness.exceptions.basicdata.BusinessDataAlreadyAddedException;
  24 import org.mxchange.jcore.facade.Facade;
  25 import org.mxchange.jcountry.data.Country;
  26 import org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber;
  27 import org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber;
  28 import org.mxchange.jphone.phonenumbers.mobile.DialableMobileNumber;
  29
  30 /**
  31  * An interface for addressbook contact manager
  32  * <p>
  33  * @author Roland Häder<roland@mxchange.org>
  34  */
  35 public interface ContactFacade extends Facade {
  36
  37         /**
  38          * Adds given Contact instance to list
  39          * <p>
  40          * @param contact Contact instance to add
  41          * <p>
  42          * @throws
  43          * org.mxchange.jcontactsbusiness.exceptions.basicdata.BusinessDataAlreadyAddedException
  44          * If the contact is already added
  45          */
  46         void addContact (final Contact contact) throws BusinessDataAlreadyAddedException;
  47
  48         /**
  49          * Let the user add a new other address
  50          */
  51         void doAddOtherAddress ();
  52
  53         /**
  54          * The user can change address data, like street, ZIP code, city and country
  55          * of given Contact instance.
  56          * <p>
  57          * @param contact Instance to change data
  58          */
  59         void doChangeAddressData (final Contact contact);
  60
  61         /**
  62          * The user can change name data, like title, surname, family name and
  63          * company name (if business contact).
  64          * <p>
  65          * @param contact Instance to change data
  66          */
  67         void doChangeNameData (final Contact contact);
  68
  69         /**
  70          * Let the user change other address
  71          */
  72         void doChangeOtherAddress ();
  73
  74         /**
  75          * The user can change other data, like phone numbers or comments.
  76          * <p>
  77          * @param contact Instance to change data
  78          */
  79         void doChangeOtherData (final Contact contact);
  80
  81         /**
  82          * Let the user change own data
  83          * <p>
  84          */
  85         void doChangeOwnData ();
  86
  87         /**
  88          * Let the user delete other address
  89          */
  90         void doDeleteOtherAddress ();
  91
  92         /**
  93          * Asks user for own data
  94          * <p>
  95          * @throws ContactAlreadyAddedException If own contact is already added
  96          */
  97         void doEnterOwnData () throws ContactAlreadyAddedException;
  98
  99         /**
 100          * List all contacts
 101          */
 102         void doListContacts ();
 103
 104         /**
 105          * Searches address book for a contact
 106          */
 107         void doSearchContacts ();
 108
 109         /**
 110          * Allows the user to enter own cellphone number.
 111          * <p>
 112          * @return Cellphone number
 113          */
 114         DialableMobileNumber enterOwnCellNumber ();
 115
 116         /**
 117          * Allows the user to enter own city name.
 118          * <p>
 119          * @return City name
 120          */
 121         String enterOwnCity ();
 122
 123         /**
 124          * Allows the user to enter comment for own entry.
 125          * <p>
 126          * @return Comment
 127          */
 128         String enterOwnComment ();
 129
 130         /**
 131          * Allows the user to enter own company name.
 132          * <p>
 133          * @return Company name
 134          */
 135         String enterOwnCompanyName ();
 136
 137         /**
 138          * Allows the user to enter own country code.
 139          * <p>
 140          * @return Country code
 141          */
 142         Country enterOwnCountryCode ();
 143
 144         /**
 145          * Allows the user to enter own email address.
 146          * <p>
 147          * @return Email address
 148          */
 149         String enterOwnEmailAddress ();
 150
 151         /**
 152          * Allows the user to enter own family name.
 153          * <p>
 154          * @return Family name
 155          */
 156         String enterOwnFamilyName ();
 157
 158         /**
 159          * Allows the user to enter own fax number.
 160          * <p>
 161          * @return Fax number
 162          */
 163         DialableFaxNumber enterOwnFaxNumber ();
 164
 165         /**
 166          * Allows the user to enter own surname.
 167          * <p>
 168          * @return Surname
 169          */
 170         String enterOwnFirstName ();
 171
 172         /**
 173          * Allows the user to enter own title.
 174          * <p>
 175          * @return PersonalTitle
 176          */
 177         PersonalTitle enterOwnPersonalTitle ();
 178
 179         /**
 180          * Allows the user to enter own phone number.
 181          * <p>
 182          * @return Phone number
 183          */
 184         DialableLandLineNumber enterOwnPhoneNumber ();
 185
 186         /**
 187          * Allows the user to enter own street and house number.
 188          * <p>
 189          * @return Street and house number
 190          */
 191         String enterOwnStreet ();
 192
 193         /**
 194          * Allows the user to enter own ZIP code.
 195          * <p>
 196          * @return ZIP code
 197          */
 198         int enterOwnZipCode ();
 199
 200         /**
 201          * Getter for column count
 202          * <p>
 203          * @return Column count TODO: This is needed for TableModel in Swing
 204          */
 205         int getColumnCount ();
 206
 207         /**
 208          * Getter for column name at given index.
 209          * <p>
 210          * @param columnIndex Column index
 211          * <p>
 212          * @return Database column name TODO: This is needed for TableModel in Swing
 213          */
 214         String getColumnName (final int columnIndex);
 215
 216         /**
 217          * Getter for translated column name at given index.
 218          * <p>
 219          * @param columnIndex Column index
 220          * <p>
 221          * @return Human-readable column name TODO: This is needed for TableModel in
 222          *         Swing
 223          */
 224         String getTranslatedColumnName (final int columnIndex);
 225
 226         /**
 227          * Somewhat "getter" for value from given row and column index
 228          * <p>
 229          * @param rowIndex    Row index
 230          * @param columnIndex Column index
 231          * <p>
 232          * @return Value from given row/column
 233          */
 234         Object getValueFromRowColumn (final int rowIndex, final int columnIndex);
 235
 236         /**
 237          * Checks whether own contact is already added by checking all entries for
 238          * isOwnContact flag
 239          * <p>
 240          * @return Whether own contact is already added
 241          * <p>
 242          * @throws java.io.IOException If an IO error occurs
 243          */
 244         boolean isOwnContactAdded () throws IOException;
 245
 246         /**
 247          * Adds given contact to address book
 248          * <p>
 249          * @param contact Contact being added TODO Add check for book size
 250          */
 251         void registerContact (final Contact contact);
 252
 253 }