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) 2013 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
19 *
20 */
21
22namespace oat\tao\model\state;
23
24/**
25 * Persistence for the item delivery service
26 */
27interface StateStorage
28{
29    public const SERVICE_ID = 'tao/stateStorage';
30
31    /**
32     * Store the state of the service call
33     *
34     * @param string $userId
35     * @param string $callId
36     * @param string $data
37     * @return boolean
38     */
39    public function set($userId, $callId, $data);
40
41    /**
42     * Retore the state of the service call
43     * Returns null if no state is found
44     *
45     * @param string $userId
46     * @param string $callId
47     * @return string
48     */
49    public function get($userId, $callId);
50
51    /**
52     * Whenever or not a state for this service call exists
53     *
54     * @param string $userId
55     * @param string $callId
56     * @return boolean
57     */
58    public function has($userId, $callId);
59
60    /**
61     * Remove the state for this service call
62     *
63     * @param string $userId
64     * @param string $callId
65     * @return boolean
66     */
67    public function del($userId, $callId);
68}