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
/**\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
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
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
/**\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