inc/classes/interfaces/application/class_ManageableApplication.php

   1 <?php
   2 /**
   3  * An interface for managing applications. This can be a lot. E.g.:
   4  *
   5  * - Un-/locking applications
   6  * - Creating selectors for the selector-mode
   7  * - Usage statistics
   8  * - And many more...
   9  *
  10  * @author              Roland Haeder <webmaster@ship-simu.org>
  11  * @version             0.0.0
  12  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
  13  * @license             GNU GPL 3.0 or any newer version
  14  * @link                http://www.ship-simu.org
  15  *
  16  * This program is free software: you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation, either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  28  */
  29 interface ManageableApplication extends FrameworkInterface {
  30         /**
  31          * Getter for application's version number
  32          *
  33          * @return      $appVersion     The application's version number
  34          */
  35         function getAppVersion ();
  36         /**
  37          * Setter for application's version number
  38          *
  39          * @param               $appVersion     The application's version number
  40          * @return      void
  41          */
  42         function setAppVersion ($appVersion);
  43
  44         /**
  45          * Getter for application's human-readable name
  46          *
  47          * @return      $appName        The application's name readable for humans
  48          */
  49         function getAppName ();
  50
  51         /**
  52          * Setter for application's human-readable name
  53          *
  54          * @param               $appName        The application's name readable for humans
  55          * @return      void
  56          */
  57         function setAppName ($appName);
  58
  59         /**
  60          * Getter for application's short uni*-like name
  61          *
  62          * @return      $shortName      The application's name readable for humans
  63          */
  64         function getAppShortName ();
  65
  66         /**
  67          * Setter for application's short uni*-like name
  68          *
  69          * @param               $shortName      The application's name readable for humans
  70          * @return      void
  71          */
  72         function setAppShortName ($shortName);
  73
  74         /**
  75          * Getter for master template name
  76          *
  77          * @return      $masterTemplate         Name of the master template
  78          */
  79         function getMasterTemplate ();
  80
  81         /**
  82          * Launches the application
  83          *
  84          * @return      void
  85          */
  86         function entryPoint ();
  87
  88         /**
  89          * Handle the indexed array of fatal messages and puts them out in an
  90          * acceptable fasion
  91          *
  92          * @param       $messageList    An array of fatal messages
  93          * @return      void
  94          */
  95         function handleFatalMessages (array $messageList);
  96 }
  97
  98 // [EOF]
  99 ?>