src/org/mxchange/jcore/client/Client.java

   1 /*
   2  * Copyright (C) 2016 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
  23 /**
  24  * An interface for application clients
  25  * <p>
  26  * @author Roland Haeder<roland@mxchange.org>
  27  */
  28 public interface Client extends FrameworkInterface {
  29
  30         /**
  31          * Shuts down the client and therefore whole application
  32          * <p>
  33          * @throws java.io.IOException If an IO error occurs
  34          * @throws java.sql.SQLException If a SQL error occurs
  35          */
  36         void doShutdown () throws IOException, SQLException;
  37
  38         /**
  39          * Enables isRunning attribute which singals that the client is running
  40          */
  41         void enableIsRunning ();
  42
  43         /**
  44          * Inizializes this client
  45          */
  46         void init ();
  47
  48         /**
  49          * Determines whether the client is still active by checking some conditions
  50          * <p>
  51          * @return Whether the client is still active
  52          */
  53         boolean isRunning ();
  54
  55         /**
  56          * Displays a message to the user
  57          * <p>
  58          * @param message Message to show to the user
  59          */
  60         void outputMessage (final String message);
  61
  62         /**
  63          * Shows introduction to user
  64          */
  65         void showWelcome ();
  66 }