Continued with re-implementation of Swing frame

[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 ea748a5478c6664f2a1793153d0bae0912aeca05..136c95a8b577be175a543a9b8e64dbbf148ed4ba 100644 (file)
--- a/Addressbook/src/org/mxchange/addressbook/client/Client.java
+++ b/Addressbook/src/org/mxchange/addressbook/client/Client.java
@@ -22,7 +22,8 @@ import org.mxchange.addressbook.contact.Contact;
 import org.mxchange.addressbook.menu.item.SelectableMenuItem;\r
 \r
 /**\r
- *\r
+ * An interface for application clients\r
+ * \r
  * @author Roland Haeder\r
  */\r
 public interface Client extends FrameworkInterface {\r
@@ -34,6 +35,38 @@ public interface Client extends FrameworkInterface {
      */\r
     public void displayAddressBox (final Contact contact);\r
 \r
+    /**\r
+     * The user changes own name data\r
+     * @param contact \r
+     */\r
+    public void doChangeOwnNameData (final Contact contact);\r
+\r
+    /**\r
+     * The user changes own address data\r
+     *\r
+     * @param contact Contact instance to change\r
+     */\r
+    public void doChangeOwnAddressData (final Contact contact);\r
+\r
+    /**\r
+     * The user changes own other data\r
+     * \r
+     * @param contact Constact instance to change\r
+     */\r
+    public void doChangeOwnOtherData (final Contact contact);\r
+\r
+    /**\r
+     * Allows the user to enter own data\r
+     * \r
+     * @return Finished Contact instance\r
+     */\r
+    public Contact doEnterOwnData ();\r
+\r
+    /**\r
+     * Shuts down the client and therefore whole application\r
+     */\r
+    public void doShutdown ();\r
+\r
     /**\r
      * Displays a message to the user\r
      *\r
@@ -74,7 +107,7 @@ public interface Client extends FrameworkInterface {
     /**\r
      * Enables isRunning attribute which singals that the client is running\r
      */\r
-    public void enableIsRunning ();\r
+    public void enableIsRunning();\r
 \r
     /**\r
      * Asks the the user to enter a single character which must match validChars\r
@@ -86,7 +119,9 @@ public interface Client extends FrameworkInterface {
     public char enterChar (final char[] validChars, final String message);\r
 \r
     /**\r
-     * Reads a string of minimum and maximum length from the user\r
+     * Reads a string of minimum and maximum length from the user. An empty\r
+     * string should be generally not allowed, but might be okay for e.g.\r
+     * company name.\r
      * \r
      * @param minLength        Minimum length of the string to read\r
      * @param maxLength        Maximum length of the string to read\r
@@ -123,15 +158,16 @@ public interface Client extends FrameworkInterface {
     public SelectableMenuItem getMenuItem (final char accessKey, final String text);\r
 \r
     /**\r
-     * Determines whether the application is still active by checking some\r
+     * Determines whether the client is still active by checking some\r
      * conditions\r
      * \r
-     * @return Whether the application is still active\r
+     * @return Whether the client is still active\r
      */\r
-    public boolean isApplicationRunning ();\r
+    public boolean isRunning();\r
 \r
     /**\r
      * Shows given menu entry in client\r
+     * \r
      * @param item Menu item to show\r
      */\r
     public void showEntry (final SelectableMenuItem item);\r
@@ -139,10 +175,15 @@ public interface Client extends FrameworkInterface {
     /**\r
      * Shows introduction to user\r
      */\r
-    public void showWelcome ();\r
+    public void showWelcome();\r
 \r
     /**\r
      * Shows current menu selection to the user\r
      */\r
-    public void showCurrentMenu ();\r
+    public void showCurrentMenu();\r
+\r
+    /**\r
+     * Inizializes this client\r
+     */\r
+    public void initClient ();\r
 }\r