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 <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
  11  * @version     0.1
  12  */
  13 interface ManageableApplication extends FrameworkInterface {
  14         /**
  15          * Getter for application's version number
  16          *
  17          * @return      $appVersion     The application's version number
  18          */
  19         function getAppVersion ();
  20         /**
  21          * Setter for application's version number
  22          *
  23          * @param               $appVersion     The application's version number
  24          * @return      void
  25          */
  26         function setAppVersion ($appVersion);
  27
  28         /**
  29          * Getter for application's human-readable name
  30          *
  31          * @return      $appName        The application's name readable for humans
  32          */
  33         function getAppName ();
  34
  35         /**
  36          * Setter for application's human-readable name
  37          *
  38          * @param               $appName        The application's name readable for humans
  39          * @return      void
  40          */
  41         function setAppName ($appName);
  42
  43         /**
  44          * Getter for application's short uni*-like name
  45          *
  46          * @return      $shortName      The application's name readable for humans
  47          */
  48         function getAppShortName ();
  49
  50         /**
  51          * Setter for application's short uni*-like name
  52          *
  53          * @param               $shortName      The application's name readable for humans
  54          * @return      void
  55          */
  56         function setAppShortName ($shortName);
  57
  58         /**
  59          * Launches the application
  60          *
  61          * @return      void
  62          */
  63         function entryPoint ();
  64 }
  65
  66 // [EOF]
  67 ?>