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
21	/**
22	* @author Jean-Sébastien Conan <jean-sebastien.conan@vesperiagroup.com>
23	*/
24
25	namespace oat\taoQtiTest\models\runner\map;
26
27	use oat\taoQtiTest\models\runner\config\RunnerConfig;
28	use oat\taoQtiTest\models\runner\RunnerServiceContext;
29
30	/**
31	* Interface RunnerMap
32	* @package oat\taoQtiTest\models\runner\map
33	*/
34	interface RunnerMap
35	{
36	//available scopes
37	public const SCOPE_TEST    = 'test';
38	public const SCOPE_PART    = 'part';
39	public const SCOPE_SECTION = 'section';
40	public const MAP_ATTRIBUTE_PARTS = 'parts';
41	public const MAP_ATTRIBUTE_SECTIONS = 'sections';
42	public const MAP_ATTRIBUTE_ITEMS = 'items';
43
44	/**
45	* Builds the map of an assessment test
46	* @param RunnerServiceContext $context The test context
47	* @param RunnerConfig $config The runner config
48	* @return mixed
49	*/
50	public function getMap(RunnerServiceContext $context, RunnerConfig $config);
51
52	/**
53	* Get the testMap for the current context but limited to the given scope
54	* @param RunnerServiceContext $context The test context
55	* @param RunnerConfig $config The runner config
56	* @param string $scope the target scope, section by default
57	* @return mixed
58	*/
59	public function getScopedMap(RunnerServiceContext $context, RunnerConfig $config, $scope = self::SCOPE_SECTION);
60	}