Added stuff for Swing client

[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 4a48b0457481acbecc5df5a224d39585fcad6d90..0d5e154d0da157444773c1532a7784c26aac4983 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,11 @@ public interface Client extends FrameworkInterface {
      */\r
     public void displayAddressBox (final Contact contact);\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
@@ -62,7 +68,7 @@ public interface Client extends FrameworkInterface {
      * @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
+    public void userChooseChangeContactData (final Contact contact) throws UnhandledUserChoiceException;\r
 \r
     /**\r
      * Asks the user for a choice and proceeds accordingly\r
@@ -74,7 +80,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 +92,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 +131,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 +148,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