application/hub/interfaces/package/class_Deliverable.php

   1 <?php
   2 /**
   3  * An interface for package delivery boys... ;-)
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 interface Deliverable extends FrameworkInterface {
  25         /**
  26          * "Enqueues" raw content into this delivery class by reading the raw content
  27          * from given template instance and pushing it on the 'undeclared' stack.
  28          *
  29          * @param       $helperInstance         A BaseHubHelper instance
  30          * @return      void
  31          */
  32         function enqueueRawDataFromTemplate (BaseHubHelper $helperInstance);
  33
  34         /**
  35          * Checks wether a package has been enqueued for delivery.
  36          *
  37          * @return      $isEnqueued             Wether a package is enqueued
  38          */
  39         function isPackageEnqueued ();
  40
  41         /**
  42          * Checks wether a package has been declared
  43          *
  44          * @return      $isDeclared             Wether a package is declared
  45          */
  46         function isPackageDeclared ();
  47
  48         /**
  49          * Checks wether a package should be sent out
  50          *
  51          * @return      $isWaitingDelivery      Wether a package is waiting for delivery
  52          */
  53         function isPackageWaitingDelivery ();
  54
  55         /**
  56          * Delivers an enqueued package to the stated destination. If a non-session
  57          * id is provided, recipient resolver is being asked (and instanced once).
  58          * This allows that a single package is being delivered to multiple targets
  59          * without enqueueing it for every target. If no target is provided or it
  60          * can't be determined a NoTargetException is being thrown.
  61          *
  62          * @return      void
  63          * @throws      NoTargetException       If no target can't be determined
  64          */
  65         function declareEnqueuedPackage ();
  66
  67         /**
  68          * Delivers the next declared package. Only one package per time will be sent
  69          * because this may take time and slows down the whole delivery
  70          * infrastructure.
  71          *
  72          * @return      void
  73          */
  74         function deliverDeclaredPackage ();
  75
  76         /**
  77          * Sends waiting packages out for delivery
  78          *
  79          * @return      void
  80          */
  81         function sendWaitingPackage ();
  82 }
  83
  84 // [EOF]
  85 ?>