3 * An interface for package delivery boys... ;-)
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 interface Deliverable extends FrameworkInterface {
26 * "Enqueues" raw content into this delivery class by reading the raw content
27 * from given helper's template instance and pushing it on the 'undeclared'
30 * @param $helperInstance An instance of a HubHelper class
33 function enqueueRawDataFromTemplate (HubHelper $helperInstance);
36 * Checks whether a package has been enqueued for delivery.
38 * @return $isEnqueued Whether a package is enqueued
40 function isPackageEnqueued ();
43 * Checks whether a package has been declared
45 * @return $isDeclared Whether a package is declared
47 function isPackageDeclared ();
50 * Checks whether a package should be sent out
52 * @return $isWaitingDelivery Whether a package is waiting for delivery
54 function isPackageWaitingForDelivery ();
57 * Checks whether encoded (raw) data is pending
59 * @return $isPending Whether encoded data is pending
61 function isEncodedDataPending ();
64 * Delivers an enqueued package to the stated destination. If a non-session
65 * id is provided, recipient resolver is being asked (and instanced once).
66 * This allows that a single package is being delivered to multiple targets
67 * without enqueueing it for every target. If no target is provided or it
68 * can't be determined a NoTargetException is being thrown.
71 * @throws NoTargetException If no target can't be determined
73 function declareEnqueuedPackage ();
76 * Processes the next declared package. Only one package per time will be
77 * processed because this may take time and slows down the whole delivery
82 function processDeclaredPackage ();
85 * Sends waiting packages out for delivery
89 function sendWaitingPackage ();
92 * Sends pending encoded (raw) data
96 function sendEncodedData ();
103 function clearAllStacks ();