Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
1 | <?php |
2 | |
3 | /** |
4 | * This program is free software; you can redistribute it and/or |
5 | * modify it under the terms of the GNU General Public License |
6 | * as published by the Free Software Foundation; under version 2 |
7 | * of the License (non-upgradable). |
8 | * |
9 | * This program is distributed in the hope that it will be useful, |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12 | * GNU General Public License for more details. |
13 | * |
14 | * You should have received a copy of the GNU General Public License |
15 | * along with this program; if not, write to the Free Software |
16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
17 | * |
18 | * Copyright (c) 2019 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT); |
19 | * |
20 | */ |
21 | |
22 | namespace oat\taoDelivery\model\Capacity; |
23 | |
24 | /** |
25 | * Service that returns the number of users the system cann support |
26 | * in addition to the users already using the system |
27 | */ |
28 | interface CapacityInterface |
29 | { |
30 | public const SERVICE_ID = 'taoDelivery/CapacityService'; |
31 | |
32 | /** |
33 | * Returns the available capacity of the system |
34 | * Will return -1 if unlimited |
35 | * |
36 | * @return int |
37 | */ |
38 | public function getCapacity(); |
39 | |
40 | /** |
41 | * transaction safe function to consume capacity |
42 | * returns true on success, false on failure |
43 | * |
44 | * @return boolean |
45 | */ |
46 | public function consume(); |
47 | } |