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) 2016 (original work) Open Assessment Technologies SA ;
19 */
20
21namespace oat\taoProctoring\model;
22
23/**
24 * Interface of service to retrieve test session history
25 *
26 * @author Aleh Hutnikau <hutnikau@1pt.com>
27 * @package oat\taoProctoring
28 */
29interface TestSessionHistoryService
30{
31    public const SERVICE_ID = 'taoProctoring/TestSessionHistoryService';
32
33    public const PROCTOR_ROLES = 'proctorRoles';
34
35    /**
36     * @param array $sessions List of session ids
37     * @param array $options The following option is handled:
38     * - periodStart:
39     * - periodEnd:
40     * - detailed: whether to retrieve detailed or brief report. Defaults to false (brief).
41     * - sortBy: column name
42     * - sortOrder: order direction (asc|desc)
43     * @return array
44     */
45    public function getSessionsHistory(array $sessions, $options);
46
47    /**
48     * Gets the url that leads to the page listing the history
49     * @param $delivery
50     * @return string
51     */
52    public function getHistoryUrl($delivery = null);
53
54    /**
55     * Gets the back url that returns to the page listing the sessions
56     * @param $delivery
57     * @return string
58     */
59    public function getBackUrl($delivery = null);
60}