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