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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
<?php
declare(strict_types=1);
/**
* @copyright 2018
*
* @author Maxence Lange <maxence@artificial-owl.com>
*
* @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\FullTextSearch\Model;
use OCP\FullTextSearch\IFullTextSearchProvider;
/**
* Interface ISearchResult
*
* When a search request is initiated, FullTextSearch will create a SearchResult
* object, based on this interface, containing the SearchRequest and the targeted
* Content Provider.
*
* The object will be passed to the Search Platform, which will proceed to the
* search and fill the SearchResult object with results.
*
* Then, the object will be passed to the targeted Content Provider that will
* improve the Search Results with detailed informations.
*
* Finally, the SearchResult is returned to the original search request.
*
* @since 15.0.0
*
*/
interface ISearchResult {
/**
* Get the original SearchRequest.
*
* @see ISearchRequest
*
* @since 15.0.0
*
* @return ISearchRequest
*/
public function getRequest(): ISearchRequest;
/**
* Get the targeted Content Provider.
*
* @since 15.0.0
*
* @return IFullTextSearchProvider
*/
public function getProvider(): IFullTextSearchProvider;
/**
* Add an IIndexDocument as one of the result of the search request.
*
* @since 15.0.0
*
* @param IIndexDocument $document
*
* @return ISearchResult
*/
public function addDocument(IIndexDocument $document): ISearchResult;
/**
* Returns all result of the search request, in an array of IIndexDocument.
*
* @since 15.0.0
*
* @return IIndexDocument[]
*/
public function getDocuments(): array;
/**
* Set an array of IIndexDocument as the result of the search request.
*
* @since 15.0.0
*
* @param IIndexDocument[] $documents
*
* @return ISearchResult
*/
public function setDocuments(array $documents): ISearchResult;
/**
* Add an aggregation to the result.
*
* @since 15.0.0
*
* @param string $category
* @param string $value
* @param int $count
*
* @return ISearchResult
*/
public function addAggregation(string $category, string $value, int $count): ISearchResult;
/**
* Get all aggregations.
*
* @since 15.0.0
*
* @param string $category
*
* @return array
*/
public function getAggregations(string $category): array;
/**
* Set the raw result of the request.
*
* @since 15.0.0
*
* @param string $result
*
* @return ISearchResult
*/
public function setRawResult(string $result): ISearchResult;
/**
* Set the total number of results for the search request.
* Used by pagination.
*
* @since 15.0.0
*
* @param int $total
*
* @return ISearchResult
*/
public function setTotal(int $total): ISearchResult;
/**
* Set the top score for the search request.
*
* @since 15.0.0
*
* @param int $score
*
* @return ISearchResult
*/
public function setMaxScore(int $score): ISearchResult;
/**
* Set the time spent by the request to perform the search.
*
* @since 15.0.0
*
* @param int $time
*
* @return ISearchResult
*/
public function setTime(int $time): ISearchResult;
/**
* Set to true if the request timed out.
*
* @since 15.0.0
*
* @param bool $timedOut
*
* @return ISearchResult
*/
public function setTimedOut(bool $timedOut): ISearchResult;
}
|
