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
  12  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
  13  * @license             GNU GPL 3.0 or any newer version
  14  *
  15  * This program is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU General Public License as published by
  17  * the Free Software Foundation, either version 3 of the License, or
  18  * (at your option) any later version.
  19  *
  20  * This program is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  * GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  27  */
  28 interface ManageableApplication extends FrameworkInterface {
  29         /**
  30          * Getter for application's version number
  31          *
  32          * @return      $appVersion     The application's version number
  33          */
  34         function getAppVersion ();
  35         /**
  36          * Setter for application's version number
  37          *
  38          * @param               $appVersion     The application's version number
  39          * @return      void
  40          */
  41         function setAppVersion ($appVersion);
  42
  43         /**
  44          * Getter for application's human-readable name
  45          *
  46          * @return      $appName        The application's name readable for humans
  47          */
  48         function getAppName ();
  49
  50         /**
  51          * Setter for application's human-readable name
  52          *
  53          * @param               $appName        The application's name readable for humans
  54          * @return      void
  55          */
  56         function setAppName ($appName);
  57
  58         /**
  59          * Getter for application's short uni*-like name
  60          *
  61          * @return      $shortName      The application's name readable for humans
  62          */
  63         function getAppShortName ();
  64
  65         /**
  66          * Setter for application's short uni*-like name
  67          *
  68          * @param               $shortName      The application's name readable for humans
  69          * @return      void
  70          */
  71         function setAppShortName ($shortName);
  72
  73         /**
  74          * Launches the application
  75          *
  76          * @return      void
  77          */
  78         function entryPoint ();
  79 }
  80
  81 // [EOF]
  82 ?>