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 (under the project TAO-PRODUCT);
19	*
20	*/
21
22	namespace oat\tao\model\datatable;
23
24	/**
25	* Interface DatatableRequest
26	* @package oat\tao\model\datatable
27	* @author Aleh Hutnikau, <hutnikau@1pt.com>
28	*/
29	interface DatatableRequest
30	{
31	public const PARAM_ROWS = 'rows';
32	public const PARAM_PAGE = 'page';
33	public const PARAM_SORT_BY = 'sortby';
34	public const PARAM_SORT_ORDER = 'sortorder';
35	public const PARAM_SORT_TYPE = 'sorttype';
36	public const PARAM_FILTERS = 'filtercolumns';
37
38	/**
39	* Get amount of records per page
40	* @return integer
41	*/
42	public function getRows();
43
44	/**
45	* Get page number
46	* @return integer
47	*/
48	public function getPage();
49
50	/**
51	* Get sorting column name
52	* @return string
53	*/
54	public function getSortBy();
55
56	/**
57	* Get sorting direction
58	* @return string
59	*/
60	public function getSortOrder();
61
62	/**
63	* Get sorting type
64	* @return string
65	*/
66	public function getSortType();
67
68	/**
69	* Get filters
70	* @return array
71	*/
72	public function getFilters();
73	}