2 * Copyright (C) 2015 Roland Haeder
\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
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
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
17 package org.mxchange.addressbook.client;
\r
19 import org.mxchange.addressbook.FrameworkInterface;
\r
20 import org.mxchange.addressbook.menu.item.SelectableMenuItem;
\r
24 * @author Roland Haeder
\r
26 public interface Client extends FrameworkInterface {
\r
29 * Displays a message to the user
\r
30 * @param message Message to show to the user
\r
32 public void displayMessage (final String message);
\r
35 * Asks the user for a choice and proceeds accordingly
\r
36 * @throws java.lang.Exception
\r
38 public void doUserChoice () throws Exception ;
\r
41 * Enables isRunning attribute which singals that the client is running
\r
43 public void enableIsRunning ();
\r
46 * Asks the the user to enter a single character which must match validChars
\r
47 * @param validChars Valid chars that are accepted
\r
48 * @param message Message to user
\r
49 * @return Allowed character
\r
51 public char enterChar (final char[] validChars, final String message);
\r
54 * Reads a string of minimum and maximum length from the user
\r
55 * @param minLength Minimum length of the string to read
\r
56 * @param maxLength Maximum length of the string to read
\r
57 * @param message Message to user
\r
60 public String enterString (final int minLength, final int maxLength, final String message);
\r
63 * Setter for current menu choice
\r
64 * @param currentMenu Current menu choice
\r
66 public void setCurrentMenu (final String currentMenu);
\r
69 * Some "Getter" for menu item
\r
70 * @param accessKey Key to press to access this menu
\r
71 * @param text Text to show to user
\r
74 public SelectableMenuItem getMenuItem (final char accessKey, final String text);
\r
77 * Determines whether the application is still active by checking some
\r
80 * @return Whether the application is still active
\r
82 public boolean isApplicationRunning ();
\r
85 * Shows given menu entry in client
\r
86 * @param item Menu item to show
\r
88 public void showEntry (final SelectableMenuItem item);
\r
91 * Shows introduction to user
\r
93 public void showWelcome ();
\r
96 * Shows current menu selection to the user
\r
98 public void showCurrentMenu ();
\r