Introduced updateAddressData() + changing own "address data" is basicly finished

[jfinancials-lib.git] / Addressbook / src / org / mxchange / addressbook / client / Client.java

diff --git a/Addressbook/src/org/mxchange/addressbook/client/Client.java b/Addressbook/src/org/mxchange/addressbook/client/Client.java
index 740a366d5111b0a7748fe7a848ed956a589378fd..4a48b0457481acbecc5df5a224d39585fcad6d90 100644 (file)
--- a/Addressbook/src/org/mxchange/addressbook/client/Client.java
+++ b/Addressbook/src/org/mxchange/addressbook/client/Client.java
@@ -17,6 +17,8 @@
 package org.mxchange.addressbook.client;\r
 \r
 import org.mxchange.addressbook.FrameworkInterface;\r
+import org.mxchange.addressbook.UnhandledUserChoiceException;\r
+import org.mxchange.addressbook.contact.Contact;\r
 import org.mxchange.addressbook.menu.item.SelectableMenuItem;\r
 \r
 /**\r
@@ -25,17 +27,49 @@ import org.mxchange.addressbook.menu.item.SelectableMenuItem;
  */\r
 public interface Client extends FrameworkInterface {\r
 \r
+    /**\r
+     * Displays a "box" for the address\r
+     *\r
+     * @param contact Contact to show address from\r
+     */\r
+    public void displayAddressBox (final Contact contact);\r
+\r
     /**\r
      * Displays a message to the user\r
+     *\r
      * @param message Message to show to the user\r
      */\r
-    public void displayMessage (final String message);\r
+    public void outputMessage (final String message);\r
+\r
+    /**\r
+     * Displays a "box" for the name\r
+     *\r
+     * @param contact Contact to show name from\r
+     */\r
+    public void displayNameBox (final Contact contact);\r
+\r
+    /**\r
+     * Displays a "box" for other data\r
+     *\r
+     * @param contact Contact to show other data from\r
+     */\r
+    public void displayOtherDataBox (final Contact contact);\r
+\r
+    /**\r
+     * Let the user choose what to change on the address: [n]ame, [a]ddress,\r
+     * [o]ther\r
+     * \r
+     * @param contact Contact instance to let the user change data\r
+     * @throws UnhandledUserChoiceException If choice is not supported\r
+     */\r
+    public void doUserChangeAdressChoice (final Contact contact) throws UnhandledUserChoiceException;\r
 \r
     /**\r
      * Asks the user for a choice and proceeds accordingly\r
-     * @throws java.lang.Exception\r
+     * \r
+     * @throws UnhandledUserChoiceException If choice is not supported\r
      */\r
-    public void doUserChoice () throws Exception ;\r
+    public void doUserMenuChoice () throws UnhandledUserChoiceException ;\r
 \r
     /**\r
      * Enables isRunning attribute which singals that the client is running\r
@@ -44,6 +78,7 @@ public interface Client extends FrameworkInterface {
 \r
     /**\r
      * Asks the the user to enter a single character which must match validChars\r
+     * \r
      * @param  validChars  Valid chars that are accepted\r
      * @param  message     Message to user\r
      * @return Allowed character\r
@@ -52,21 +87,35 @@ public interface Client extends FrameworkInterface {
 \r
     /**\r
      * Reads a string of minimum and maximum length from the user\r
+     * \r
      * @param minLength        Minimum length of the string to read\r
      * @param maxLength        Maximum length of the string to read\r
      * @param message  Message to user\r
-     * @return \r
+     * @param allowEmpty Whether empty strings are allowed\r
+     * @return Entered string by user or null if empty string is allowed\r
+     */\r
+    public String enterString (final int minLength, final int maxLength, final String message, final boolean allowEmpty);\r
+\r
+    /**\r
+     * Reads an integer (int) from the user\r
+     * \r
+     * @param minimum Minimum allowed number\r
+     * @param maximum Maximum allowed number\r
+     * @param message  Message to user\r
+     * @return Entered string by user or null if empty string is allowed\r
      */\r
-    public String enterString (final int minLength, final int maxLength, final String message);\r
+    public int enterInt (final int minimum, final int maximum, final String message);\r
 \r
     /**\r
      * Setter for current menu choice\r
+     * \r
      * @param currentMenu Current menu choice\r
      */\r
     public void setCurrentMenu (final String currentMenu);\r
 \r
     /**\r
      * Some "Getter" for menu item\r
+     * \r
      * @param accessKey Key to press to access this menu\r
      * @param text Text to show to user\r
      * @return \r