src/org/mxchange/addressbook/manager/contact/ManageableAddressbookContact.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.addressbook.manager.contact;
  18
  19 import java.io.IOException;
  20 import java.lang.reflect.InvocationTargetException;
  21 import java.sql.SQLException;
  22 import org.mxchange.addressbook.exceptions.ContactAlreadyAddedException;
  23 import org.mxchange.jcore.contact.Contact;
  24 import org.mxchange.jcore.contact.Gender;
  25 import org.mxchange.jcore.exceptions.BadTokenException;
  26 import org.mxchange.jcore.exceptions.CorruptedDatabaseFileException;
  27 import org.mxchange.jcore.manager.database.ManageableDatabase;
  28
  29 /**
  30  *
  31  * @author Roland Haeder
  32  */
  33 public interface ManageableAddressbookContact extends ManageableDatabase {
  34         /**
  35          * Allows the user to enter own cellphone number.
  36          *
  37          * @return Cellphone number
  38          */
  39         public String enterOwnCellNumber ();
  40
  41         /**
  42          * Allows the user to enter own city name.
  43          *
  44          * @return City name
  45          */
  46         public String enterOwnCity ();
  47
  48         /**
  49          * Allows the user to enter comment for own entry.
  50          *
  51          * @return Comment
  52          */
  53         public String enterOwnComment ();
  54
  55         /**
  56          * Allows the user to enter own company name.
  57          *
  58          * @return Company name
  59          */
  60         public String enterOwnCompanyName ();
  61
  62         /**
  63          * Allows the user to enter own country code.
  64          *
  65          * @return Country code
  66          */
  67         public String enterOwnCountryCode ();
  68
  69         /**
  70          * Allows the user to enter own email address.
  71          *
  72          * @return Email address
  73          */
  74         public String enterOwnEmailAddress ();
  75
  76         /**
  77          * Allows the user to enter own family name.
  78          *
  79          * @return Family name
  80          */
  81         public String enterOwnFamilyName ();
  82
  83         /**
  84          * Allows the user to enter own fax number.
  85          *
  86          * @return Fax number
  87          */
  88         public String enterOwnFaxNumber ();
  89
  90         /**
  91          * Allows the user to enter own gender.
  92          *
  93          * @return Gender
  94          */
  95         public Gender enterOwnGender ();
  96
  97         /**
  98          * Allows the user to enter own phone number.
  99          *
 100          * @return Phone number
 101          */
 102         public String enterOwnPhoneNumber ();
 103
 104         /**
 105          * Allows the user to enter own street and house number.
 106          *
 107          * @return Street and house number
 108          */
 109         public String enterOwnStreet ();
 110
 111         /**
 112          * Allows the user to enter own surname.
 113          *
 114          * @return Surname
 115          */
 116         public String enterOwnFirstName ();
 117
 118         /**
 119          * Allows the user to enter own ZIP code.
 120          *
 121          * @return ZIP code
 122          */
 123         public int enterOwnZipCode ();
 124
 125         /**
 126          * List all contacts
 127          */
 128         public void doListContacts ();
 129
 130         /**
 131          * Adds given contact to address book
 132          *
 133          * @param contact Contact being added
 134          * TODO Add check for book size
 135          */
 136         public void registerContact (final Contact contact);
 137
 138         /**
 139          * Adds given Contact instance to list
 140          *
 141          * @param contact Contact instance to add
 142          * @throws org.mxchange.addressbook.exceptions.ContactAlreadyAddedException If the contact is already added
 143          */
 144         public void addContact (final Contact contact) throws ContactAlreadyAddedException;
 145
 146         /**
 147          * Let the user add a new other address
 148          */
 149         public void doAddOtherAddress ();
 150
 151         /**
 152          * The user can change address data, like street, ZIP code, city and country
 153          * of given Contact instance.
 154          *
 155          * @param contact Instance to change data
 156          */
 157         public void doChangeAddressData (final Contact contact);
 158
 159         /**
 160          * The user can change name data, like gender, surname, family name and
 161          * company name (if business contact).
 162          *
 163          * @param contact Instance to change data
 164          */
 165         public void doChangeNameData (final Contact contact);
 166
 167         /**
 168          * Let the user change other address
 169          */
 170         public void doChangeOtherAddress ();
 171
 172         /**
 173          * The user can change other data, like phone numbers or comments.
 174          *
 175          * @param contact Instance to change data
 176          */
 177         public void doChangeOtherData (final Contact contact);
 178
 179         /**
 180          * Let the user change own data
 181          * @throws java.sql.SQLException If an SQL error occurs
 182          * @throws java.io.IOException If an IO error occurs
 183          * @throws org.mxchange.jcore.exceptions.BadTokenException Continued throw
 184          * @throws org.mxchange.jcore.exceptions.CorruptedDatabaseFileException If the database file is damaged
 185          * @throws java.lang.NoSuchMethodException If a method cannot be found
 186          * @throws java.lang.IllegalAccessException If a method is not accessible
 187          * @throws java.lang.reflect.InvocationTargetException Any other problems?
 188          */
 189         public void doChangeOwnData () throws IOException , BadTokenException, CorruptedDatabaseFileException, SQLException, NoSuchMethodException, IllegalAccessException, InvocationTargetException;
 190
 191         /**
 192          * Let the user delete other address
 193          */
 194         public void doDeleteOtherAddress ();
 195
 196         /**
 197          * Asks user for own data
 198          * @throws org.mxchange.addressbook.exceptions.ContactAlreadyAddedException If own contact is already added
 199          * @throws java.io.IOException If an IO error was found
 200          * @throws org.mxchange.jcore.exceptions.BadTokenException If a bad token was found
 201          */
 202         public void doEnterOwnData () throws ContactAlreadyAddedException, IOException , BadTokenException;
 203
 204         /**
 205          * Searches address book for a contact
 206          */
 207         public void doSearchContacts ();
 208
 209         /**
 210          * Checks whether own contact is already added by checking all entries for
 211          * isOwnContact flag
 212          *
 213          * @return Whether own contact is already added
 214          * @throws java.io.IOException If an IO error occurs
 215          * @throws org.mxchange.jcore.exceptions.BadTokenException If a bad token was found
 216          */
 217         public boolean isOwnContactAdded () throws IOException, BadTokenException;
 218 }