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) 2017 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
19	*
20	*/
21
22	namespace oat\taoOutcomeUi\model\export;
23
24	use Zend\ServiceManager\ServiceLocatorAwareInterface;
25
26	/**
27	* ResultsExporterInterface
28	*
29	* @author Gyula Szucs <gyula@taotesting.com>
30	*/
31	interface ResultsExporterInterface extends ServiceLocatorAwareInterface
32	{
33	/**
34	* @return \core_kernel_classes_Resource
35	*/
36	public function getResourceToExport();
37
38	/**
39	* @param array|string $columnsToExport An array of columns properties or a JSON string
40	* @return ResultsExporterInterface
41	*/
42	public function setColumnsToExport($columnsToExport);
43
44	/**
45	* @return \tao_models_classes_table_Column[]
46	*/
47	public function getColumnsToExport();
48
49	/**
50	* @param string $variableToExport
51	* @return ResultsExporterInterface
52	*/
53	public function setVariableToExport($variableToExport);
54
55	/**
56	* @return string
57	*/
58	public function getVariableToExport();
59
60	/**
61	* @param array $filters
62	* @return ResultsExporterInterface
63	*/
64	public function setFiltersToExport($filters);
65
66	/**
67	* @return array
68	*/
69	public function getFiltersToExport();
70
71	/**
72	* @param array $storageOptions
73	* @see \oat\taoResultServer\models\classes\ResultManagement::getResultByDelivery()
74	* @return ResultsExporterInterface
75	*/
76	public function setStorageOptions(array $storageOptions);
77
78	/**
79	* Get data to be exported.
80	*
81	* @return array
82	*/
83	public function getData();
84
85	/**
86	* @param null|string $destination Path of the DIRECTORY where the export file(s) should be saved.
87	* @return string Name of the created file
88	*/
89	public function export($destination = null);
90	}