Addressbook/src/org/mxchange/addressbook/FrameworkInterface.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.addressbook;
  18
  19 import org.mxchange.addressbook.application.Application;
  20 import org.mxchange.addressbook.client.Client;
  21 import org.mxchange.addressbook.manager.contact.ManageableContact;
  22
  23 /**
  24  * A general interface which should be always expanded
  25  *
  26  * @author Roland Haeder
  27  */
  28 public interface FrameworkInterface {
  29         /*
  30          * Properties file name
  31          */
  32         public static final String PROPERTIES_CONFIG_FILE = "config.properties";
  33
  34         /**
  35          * Getter for contact manager
  36          *
  37          * @return Contact manager instance
  38          */
  39         public ManageableContact getContactManager ();
  40
  41         /**
  42          * Client instance
  43          *
  44          * @return the client
  45          */
  46         public Client getClient ();
  47
  48         /**
  49          * Application instance
  50          *
  51          * @return the application
  52          */
  53         public Application getApplication ();
  54
  55         /**
  56          * Getter for human-readable string from given key
  57          *
  58          * @param key Key to return
  59          * @return Human-readable message
  60          */
  61         public String getMessageStringFromKey (final String key);
  62
  63         /**
  64          * Logs given exception
  65          *
  66          * @param exception Exception to log
  67          */
  68         public void logException (final Throwable exception);
  69 }