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