]> git.mxchange.org Git - addressbook-swing.git/blobdiff - Addressbook/src/org/mxchange/addressbook/manager/contact/ManageableContact.java
Moved a lot classes and interfaces (generalized) to new jcore project + added a few...
[addressbook-swing.git] / Addressbook / src / org / mxchange / addressbook / manager / contact / ManageableContact.java
index 928df17dc8032373502cdb9cc24f27f7bfc91a9e..cc22934f816c48a687467cedf39feed060adb7bb 100644 (file)
  */
 package org.mxchange.addressbook.manager.contact;
 
-import java.util.List;
-import org.mxchange.addressbook.client.Client;
 import org.mxchange.addressbook.contact.Contact;
-import org.mxchange.addressbook.manager.Manageable;
+import org.mxchange.addressbook.contact.Gender;
+import org.mxchange.addressbook.exceptions.ContactAlreadyAddedException;
+import org.mxchange.jcore.manager.Manageable;
 
 /**
  *
  * @author Roland Haeder
  */
 public interface ManageableContact extends Manageable {
-
-    /**
-     * Shuts down this contact manager
-     */
-    public void doShutdown ();
-
-    /**
-     * Allows the user to enter own cellphone number.
-     * 
-     * @return Cellphone number
-     */
-    public String enterOwnCellNumber ();
-
-    /**
-     * Allows the user to enter own city name.
-     * 
-     * @return City name
-     */
-    public String enterOwnCity ();
-
-    /**
-     * Allows the user to enter comment for own entry.
-     * 
-     * @return Comment
-     */
-    public String enterOwnComment ();
-
-    /**
-     * Allows the user to enter own company name.
-     * 
-     * @return Company name
-     */
-    public String enterOwnCompanyName ();
-
-    /**
-     * Allows the user to enter own country code.
-     * 
-     * @return Country code
-     */
-    public String enterOwnCountryCode ();
-
-    /**
-     * Allows the user to enter own email address.
-     * 
-     * @return Email address
-     */
-    public String enterOwnEmailAddress ();
-
-    /**
-     * Allows the user to enter own family name.
-     * 
-     * @return Family name
-     */
-    public String enterOwnFamilyName ();
-
-    /**
-     * Allows the user to enter own fax number.
-     * 
-     * @return Fax number
-     */
-    public String enterOwnFaxNumber ();
-
-    /**
-     * Allows the user to enter own gender.
-     * 
-     * @return Gender
-     */
-    public char enterOwnGender ();
-
-    /**
-     * Allows the user to enter own phone number.
-     * 
-     * @return Phone number
-     */
-    public String enterOwnPhoneNumber ();
-
-    /**
-     * Allows the user to enter own street and house number.
-     * 
-     * @return Street and house number
-     */
-    public String enterOwnStreet ();
-
-    /**
-     * Allows the user to enter own surname.
-     * 
-     * @return Surname
-     */
-    public String enterOwnSurname ();
-
-    /**
-     * Allows the user to enter own ZIP code.
-     * 
-     * @return ZIP code
-     */
-    public int enterOwnZipCode ();
-
-    /**
-     * Getter for column count
-     * 
-     * @return Column count
-     */
-    public int getColumnCount ();
-
-    /**
-     * List all contacts
-     */
-    public void doListContacts ();
-
-    /**
-     * Getter for column name at given index.
-     * 
-     * @param columnIndex Column index
-     * @return Human-readable column name
-     */
-    public String getColumnName (final int columnIndex);
-
-    /**
-     * Adds given contact to address book
-     *
-     * @param contact Contact being added
-     * @todo Add check for book size
-     */
-    public void registerContact (final Contact contact);
-
-    /**
-     * Adds given Contact instance to list
-     * 
-     * @param contact Contact instance to add
-     */
-    public void addContact (final Contact contact);
-
-    /**
-     * Let the user add a new other address
-     */
-    public void doAddOtherAddress();
-
-    /**
-     * The user can change address data, like street, ZIP code, city and country
-     * of given Contact instance.
-     * 
-     * @param contact Instance to change data
-     * @param client Client instance to call back
-     */
-    public void doChangeAddressData (final Contact contact, final Client client);
-
-    /**
-     * The user can change name data, like gender, surname, family name and
-     * company name (if business contact).
-     * 
-     * @param contact Instance to change data
-     * @param client Client instance to call back
-     */
-    public void doChangeNameData (final Contact contact, final Client client);
-
-    /**
-     * Let the user change other address
-     */
-    public void doChangeOtherAddress();
-
-    /**
-     * The user can change other data, like phone numbers or comments.
-     * 
-     * @param contact Instance to change data
-     * @param client Client instance to call back
-     */
-    public void doChangeOtherData (final Contact contact, final Client client);
-
-    /**
-     * Let the user change own data
-     */
-    public void doChangeOwnData();
-
-    /**
-     * Let the user delete other address
-     */
-    public void doDeleteOtherAddress();
-
-    /**
-     * Asks user for own data
-     */
-    public void doEnterOwnData();
-
-    /**
-     * Getter for whole list
-     * @return List of all contacts
-     */
-    public List<Contact> getList ();
-
-    /**
-     * Searches address book for a contact
-     */
-    public void doSearchContacts ();
-
-    /**
-     * Checks whether own contact is already added by checking all entries for
-     * isOwnContact flag
-     * 
-     * @return Whether own contact is already added
-     */
-    public boolean isOwnContactAdded ();
-
-    /**
-     * Getter for size
-     *
-     * @return size of contact "book"
-     */
-    public int size();
+       /**
+        * Allows the user to enter own cellphone number.
+        *
+        * @return Cellphone number
+        */
+       public String enterOwnCellNumber ();
+
+       /**
+        * Allows the user to enter own city name.
+        *
+        * @return City name
+        */
+       public String enterOwnCity ();
+
+       /**
+        * Allows the user to enter comment for own entry.
+        *
+        * @return Comment
+        */
+       public String enterOwnComment ();
+
+       /**
+        * Allows the user to enter own company name.
+        *
+        * @return Company name
+        */
+       public String enterOwnCompanyName ();
+
+       /**
+        * Allows the user to enter own country code.
+        *
+        * @return Country code
+        */
+       public String enterOwnCountryCode ();
+
+       /**
+        * Allows the user to enter own email address.
+        *
+        * @return Email address
+        */
+       public String enterOwnEmailAddress ();
+
+       /**
+        * Allows the user to enter own family name.
+        *
+        * @return Family name
+        */
+       public String enterOwnFamilyName ();
+
+       /**
+        * Allows the user to enter own fax number.
+        *
+        * @return Fax number
+        */
+       public String enterOwnFaxNumber ();
+
+       /**
+        * Allows the user to enter own gender.
+        *
+        * @return Gender
+        */
+       public Gender enterOwnGender ();
+
+       /**
+        * Allows the user to enter own phone number.
+        *
+        * @return Phone number
+        */
+       public String enterOwnPhoneNumber ();
+
+       /**
+        * Allows the user to enter own street and house number.
+        *
+        * @return Street and house number
+        */
+       public String enterOwnStreet ();
+
+       /**
+        * Allows the user to enter own surname.
+        *
+        * @return Surname
+        */
+       public String enterOwnSurname ();
+
+       /**
+        * Allows the user to enter own ZIP code.
+        *
+        * @return ZIP code
+        */
+       public int enterOwnZipCode ();
+
+       /**
+        * Getter for column count
+        *
+        * @return Column count
+        */
+       public int getColumnCount ();
+
+       /**
+        * List all contacts
+        */
+       public void doListContacts ();
+
+       /**
+        * Getter for column name at given index.
+        *
+        * @param columnIndex Column index
+        * @return Database column name
+        */
+       public String getColumnName (final int columnIndex);
+
+       /**
+        * Getter for translated column name at given index.
+        *
+        * @param columnIndex Column index
+        * @return Human-readable column name
+        */
+       public String getTranslatedColumnName (int columnIndex);
+
+       /**
+        * Somewhat "getter" for value from given row and column index
+        *
+        * @param rowIndex Row index
+        * @param columnIndex Column index
+        * @return Value from given row/column
+        */
+       public Object getValueFromRowColumn (final int rowIndex, final int columnIndex);
+
+       /**
+        * Adds given contact to address book
+        *
+        * @param contact Contact being added
+        * @todo Add check for book size
+        */
+       public void registerContact (final Contact contact);
+
+       /**
+        * Adds given Contact instance to list
+        *
+        * @param contact Contact instance to add
+        * @throws org.mxchange.addressbook.exceptions.ContactAlreadyAddedException If the contact is already added
+        */
+       public void addContact (final Contact contact) throws ContactAlreadyAddedException;
+
+       /**
+        * Let the user add a new other address
+        */
+       public void doAddOtherAddress ();
+
+       /**
+        * The user can change address data, like street, ZIP code, city and country
+        * of given Contact instance.
+        *
+        * @param contact Instance to change data
+        */
+       public void doChangeAddressData (final Contact contact);
+
+       /**
+        * The user can change name data, like gender, surname, family name and
+        * company name (if business contact).
+        *
+        * @param contact Instance to change data
+        */
+       public void doChangeNameData (final Contact contact);
+
+       /**
+        * Let the user change other address
+        */
+       public void doChangeOtherAddress ();
+
+       /**
+        * The user can change other data, like phone numbers or comments.
+        *
+        * @param contact Instance to change data
+        */
+       public void doChangeOtherData (final Contact contact);
+
+       /**
+        * Let the user change own data
+        */
+       public void doChangeOwnData ();
+
+       /**
+        * Let the user delete other address
+        */
+       public void doDeleteOtherAddress ();
+
+       /**
+        * Asks user for own data
+        * @throws org.mxchange.addressbook.exceptions.ContactAlreadyAddedException If own contact is already added
+        */
+       public void doEnterOwnData () throws ContactAlreadyAddedException;
+
+       /**
+        * Searches address book for a contact
+        */
+       public void doSearchContacts ();
+
+       /**
+        * Checks whether own contact is already added by checking all entries for
+        * isOwnContact flag
+        *
+        * @return Whether own contact is already added
+        */
+       public boolean isOwnContactAdded ();
+
+       /**
+        * Getter for size
+        *
+        * @return size of contact "book"
+        */
+       public int size ();
 }