Stacker classes/interface/exceptions (FiFoStacker is not completed, will follow soon...
[core.git] / inc / classes / interfaces / points / class_BookablePoints.php
1 <?php
2 /**
3  * An interface for bookable points
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core 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 BookablePoints extends FrameworkInterface {
25         /**
26          * Checks wether the user has the required amount of points left for the specified action
27          *
28          * @param       $action                 The action or configuration entry plus prefix the user wants to perform
29          * @return      $hasRequired    Wether the user has the required points
30          */
31         function ifUserHasRequiredPoints ($action);
32
33         /**
34          * "Books" the given points amount on the current user's account
35          *
36          * @param       $amount         Amount of points we shall book
37          * @return      void
38          */
39         function bookPointsDirectly ($amount);
40
41         /**
42          * Adds registration elements to a given dataset instance
43          *
44          * @param       $criteriaInstance       An instance of a storeable criteria
45          * @return      void
46          */
47         function addElementsToDataSet (StoreableCriteria $criteriaInstance);
48 }
49
50 // [EOF]
51 ?>