src/org/mxchange/jcore/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.jcore.client;
  18
  19 import org.mxchange.jcore.FrameworkInterface;
  20 import org.mxchange.jcore.contact.Contact;
  21
  22 /**
  23  * An interface for application clients
  24  *
  25  * @author Roland Haeder
  26  */
  27 public interface Client extends FrameworkInterface {
  28
  29         /**
  30          * Shuts down the client and therefore whole application
  31          */
  32         public void doShutdown ();
  33
  34         /**
  35          * Displays a message to the user
  36          *
  37          * @param message Message to show to the user
  38          */
  39         public void outputMessage (final String message);
  40
  41         /**
  42          * Enables isRunning attribute which singals that the client is running
  43          */
  44         public void enableIsRunning ();
  45
  46         /**
  47          * Determines whether the client is still active by checking some conditions
  48          *
  49          * @return Whether the client is still active
  50          */
  51         public boolean isRunning ();
  52
  53         /**
  54          * Shows introduction to user
  55          */
  56         public void showWelcome ();
  57
  58         /**
  59          * Inizializes this client
  60          */
  61         public void init ();
  62
  63         /**
  64          * Displays a "box" for the address
  65          *
  66          * @param contact Contact to show address from
  67          */
  68         public void displayAddressBox (final Contact contact);
  69
  70         /**
  71          * Displays a "box" for the name
  72          *
  73          * @param contact Contact to show name from
  74          */
  75         public void displayNameBox (final Contact contact);
  76
  77         /**
  78          * Displays a "box" for other data
  79          *
  80          * @param contact Contact to show other data from
  81          */
  82         public void displayOtherDataBox (final Contact contact);
  83 }