Addressbook/src/org/mxchange/addressbook/client/Client.java

   1 /*\r
   2  * Copyright (C) 2015 Roland Haeder\r
   3  *\r
   4  * This program is free software: you can redistribute it and/or modify\r
   5  * it under the terms of the GNU General Public License as published by\r
   6  * the Free Software Foundation, either version 3 of the License, or\r
   7  * (at your option) any later version.\r
   8  *\r
   9  * This program is distributed in the hope that it will be useful,\r
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  12  * GNU General Public License for more details.\r
  13  *\r
  14  * You should have received a copy of the GNU General Public License\r
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
  16  */\r
  17 package org.mxchange.addressbook.client;\r
  18 \r
  19 import org.mxchange.addressbook.FrameworkInterface;\r
  20 import org.mxchange.addressbook.UnhandledUserChoiceException;\r
  21 import org.mxchange.addressbook.contact.Contact;\r
  22 import org.mxchange.addressbook.menu.item.SelectableMenuItem;\r
  23 \r
  24 /**\r
  25  * An interface for application clients\r
  26  * \r
  27  * @author Roland Haeder\r
  28  */\r
  29 public interface Client extends FrameworkInterface {\r
  30 \r
  31     /**\r
  32      * Displays a "box" for the address\r
  33      *\r
  34      * @param contact Contact to show address from\r
  35      */\r
  36     public void displayAddressBox (final Contact contact);\r
  37 \r
  38     /**\r
  39      * Shuts down the client and therefore whole application\r
  40      */\r
  41     public void doShutdown ();\r
  42 \r
  43     /**\r
  44      * Displays a message to the user\r
  45      *\r
  46      * @param message Message to show to the user\r
  47      */\r
  48     public void outputMessage (final String message);\r
  49 \r
  50     /**\r
  51      * Displays a "box" for the name\r
  52      *\r
  53      * @param contact Contact to show name from\r
  54      */\r
  55     public void displayNameBox (final Contact contact);\r
  56 \r
  57     /**\r
  58      * Displays a "box" for other data\r
  59      *\r
  60      * @param contact Contact to show other data from\r
  61      */\r
  62     public void displayOtherDataBox (final Contact contact);\r
  63 \r
  64     /**\r
  65      * Let the user choose what to change on the address: [n]ame, [a]ddress,\r
  66      * [o]ther\r
  67      * \r
  68      * @param contact Contact instance to let the user change data\r
  69      * @throws UnhandledUserChoiceException If choice is not supported\r
  70      */\r
  71     public void userChooseChangeContactData (final Contact contact) throws UnhandledUserChoiceException;\r
  72 \r
  73     /**\r
  74      * Asks the user for a choice and proceeds accordingly\r
  75      * \r
  76      * @throws UnhandledUserChoiceException If choice is not supported\r
  77      */\r
  78     public void doUserMenuChoice () throws UnhandledUserChoiceException ;\r
  79 \r
  80     /**\r
  81      * Enables isRunning attribute which singals that the client is running\r
  82      */\r
  83     public void enableIsRunning();\r
  84 \r
  85     /**\r
  86      * Asks the the user to enter a single character which must match validChars\r
  87      * \r
  88      * @param   validChars  Valid chars that are accepted\r
  89      * @param   message     Message to user\r
  90      * @return  Allowed character\r
  91      */\r
  92     public char enterChar (final char[] validChars, final String message);\r
  93 \r
  94     /**\r
  95      * Reads a string of minimum and maximum length from the user. An empty\r
  96      * string should be generally not allowed, but might be okay for e.g.\r
  97      * company name.\r
  98      * \r
  99      * @param minLength Minimum length of the string to read\r
 100      * @param maxLength Maximum length of the string to read\r
 101      * @param message   Message to user\r
 102      * @param allowEmpty Whether empty strings are allowed\r
 103      * @return Entered string by user or null if empty string is allowed\r
 104      */\r
 105     public String enterString (final int minLength, final int maxLength, final String message, final boolean allowEmpty);\r
 106 \r
 107     /**\r
 108      * Reads an integer (int) from the user\r
 109      * \r
 110      * @param minimum Minimum allowed number\r
 111      * @param maximum Maximum allowed number\r
 112      * @param message   Message to user\r
 113      * @return Entered string by user or null if empty string is allowed\r
 114      */\r
 115     public int enterInt (final int minimum, final int maximum, final String message);\r
 116 \r
 117     /**\r
 118      * Setter for current menu choice\r
 119      * \r
 120      * @param currentMenu Current menu choice\r
 121      */\r
 122     public void setCurrentMenu (final String currentMenu);\r
 123 \r
 124     /**\r
 125      * Some "Getter" for menu item\r
 126      * \r
 127      * @param accessKey Key to press to access this menu\r
 128      * @param text Text to show to user\r
 129      * @return \r
 130      */\r
 131     public SelectableMenuItem getMenuItem (final char accessKey, final String text);\r
 132 \r
 133     /**\r
 134      * Determines whether the client is still active by checking some\r
 135      * conditions\r
 136      * \r
 137      * @return Whether the client is still active\r
 138      */\r
 139     public boolean isRunning();\r
 140 \r
 141     /**\r
 142      * Shows given menu entry in client\r
 143      * \r
 144      * @param item Menu item to show\r
 145      */\r
 146     public void showEntry (final SelectableMenuItem item);\r
 147 \r
 148     /**\r
 149      * Shows introduction to user\r
 150      */\r
 151     public void showWelcome();\r
 152 \r
 153     /**\r
 154      * Shows current menu selection to the user\r
 155      */\r
 156     public void showCurrentMenu();\r
 157 \r
 158     /**\r
 159      * Inizializes this client\r
 160      */\r
 161     public void initClient ();\r
 162 }\r