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

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