blob: 91c6f6425666ccc781b5dd78701c498dfa417623 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
<?php
/**
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
*
* @author Robin Appelman <robin@icewind.nl>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\Files\Search;
use OCP\IUser;
/**
* @since 12.0.0
*/
interface ISearchQuery {
/**
* @return ISearchOperator
* @since 12.0.0
*/
public function getSearchOperation();
/**
* Get the maximum number of results to return
*
* @return integer
* @since 12.0.0
*/
public function getLimit();
/**
* Get the offset for returned results
*
* @return integer
* @since 12.0.0
*/
public function getOffset();
/**
* The fields and directions to order by
*
* @return ISearchOrder[]
* @since 12.0.0
*/
public function getOrder();
/**
* The user that issued the search
*
* @return ?IUser
* @since 12.0.0
*/
public function getUser();
/**
* Whether or not the search should be limited to the users home storage
*
* @return bool
* @since 18.0.0
*/
public function limitToHome(): bool;
}
|
