Completed
Push — develop ( 902805...e53bfb )
by Ben
8s
created

Results::getWarnings()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
c 1
b 0
f 1
dl 0
loc 4
rs 10
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
3
namespace GroupByInc\API\Model;
4
5
use JMS\Serializer\Annotation as JMS;
6
7
class Results
8
{
9
    /**
10
     * @var int
11
     * @JMS\Type("integer")
12
     */
13
    public $totalRecordCount;
14
    /**
15
     * @var string
16
     * @JMS\Type("string")
17
     */
18
    public $area;
19
    /**
20
     * @var string
21
     * @JMS\Type("string")
22
     */
23
    public $biasingProfile;
24
    /**
25
     * @var string
26
     * @JMS\Type("string")
27
     */
28
    public $redirect;
29
    /**
30
     * @var string
31
     * @JMS\Type("string")
32
     */
33
    public $errors;
34
    /**
35
     * @var string
36
     * @JMS\Type("string")
37
     */
38
    public $query;
39
    /**
40
     * @var string
41
     * @JMS\Type("string")
42
     */
43
    public $originalQuery;
44
    /**
45
     * @var string
46
     * @JMS\Type("string")
47
     */
48
    public $correctedQuery;
49
50
    /**
51
     * @var Template
52
     * @JMS\Type("GroupByInc\API\Model\Template")
53
     */
54
    public $template;
55
    /**
56
     * @var PageInfo
57
     * @JMS\Type("GroupByInc\API\Model\PageInfo")
58
     */
59
    public $pageInfo;
60
    /**
61
     * @var Navigation[]
62
     * @JMS\Type("array<GroupByInc\API\Model\Navigation>")
63
     */
64
    public $availableNavigation = array();
65
    /**
66
     * @var Navigation[]
67
     * @JMS\Type("array<GroupByInc\API\Model\Navigation>")
68
     */
69
    public $selectedNavigation = array();
70
71
    /**
72
     * @var Record[]
73
     * @JMS\Type("array<GroupByInc\API\Model\Record>")
74
     */
75
    public $records = array();
76
    /**
77
     * @var string[]
78
     * @JMS\Type("array<string>")
79
     */
80
    public $didYouMean = array();
81
    /**
82
     * @var string[]
83
     * @JMS\Type("array<string>")
84
     */
85
    public $relatedQueries = array();
86
    /**
87
     * @var string[]
88
     * @JMS\Type("array<string>")
89
     */
90
    public $rewrites = array();
91
    /**
92
     * @var Metadata[]
93
     * @JMS\Type("array<GroupByInc\API\Model\Metadata>")
94
     */
95
    public $siteParams = array();
96
97
    /**
98
     * @var string[]
99
     * @JMS\Type("array<string>")
100
     */
101
    public $warnings = array();
102
103
    /**
104
     * @return string[] A list of spell corrections based on the search term.
105
     */
106
    public function getDidYouMean()
107
    {
108
        return $this->didYouMean;
109
    }
110
111
    /**
112
     * @param string[] $didYouMean Set the list.
113
     */
114
    public function setDidYouMean($didYouMean)
115
    {
116
        $this->didYouMean = $didYouMean;
117
    }
118
119
    /**
120
     * @return string[] A list of related queries for a given search term.
121
     */
122
    public function getRelatedQueries()
123
    {
124
        return $this->relatedQueries;
125
    }
126
127
    /**
128
     * @param string[] $relatedQueries Set the related queries for a search term.
129
     */
130
    public function setRelatedQueries($relatedQueries)
131
    {
132
        $this->relatedQueries = $relatedQueries;
133
    }
134
135
    /**
136
     * @return Record[] A list of the records for this search and navigation state.
137
     */
138
    public function getRecords()
139
    {
140
        return $this->records;
141
    }
142
143
    /**
144
     * @param Record[] $records Set the records.
145
     */
146
    public function setRecords($records)
147
    {
148
        $this->records = $records;
149
    }
150
151
    /**
152
     * @return Template If a rule has fired, the associated template will be returned.
153
     */
154
    public function getTemplate()
155
    {
156
        return $this->template;
157
    }
158
159
    /**
160
     * @param Template $template Set the template.
161
     */
162
    public function setTemplate($template)
163
    {
164
        $this->template = $template;
165
    }
166
167
    /**
168
     * @return PageInfo Information about the results page.
169
     */
170
    public function getPageInfo()
171
    {
172
        return $this->pageInfo;
173
    }
174
175
    /**
176
     * @param PageInfo $pageInfo Set the page info.
177
     */
178
    public function setPageInfo($pageInfo)
179
    {
180
        $this->pageInfo = $pageInfo;
181
    }
182
183
    /**
184
     * @return Navigation[] A list of all the ways in which you can filter the current result set.
185
     */
186
    public function getAvailableNavigation()
187
    {
188
        return $this->availableNavigation;
189
    }
190
191
    /**
192
     * @param Navigation[] $availableNavigation Set the available navigation.
193
     */
194
    public function setAvailableNavigation($availableNavigation)
195
    {
196
        $this->availableNavigation = $availableNavigation;
197
    }
198
199
    /**
200
     * @return Navigation[] A list of the currently selected navigations. Also known as breadcrumbs.
201
     */
202
    public function getSelectedNavigation()
203
    {
204
        return $this->selectedNavigation;
205
    }
206
207
    /**
208
     * @param Navigation[] $selectedNavigation Set the selected navigations.
209
     */
210
    public function setSelectedNavigation($selectedNavigation)
211
    {
212
        $this->selectedNavigation = $selectedNavigation;
213
    }
214
215
    /**
216
     * @return string A URL to redirect to based on this search term.
217
     */
218
    public function getRedirect()
219
    {
220
        return $this->redirect;
221
    }
222
223
    /**
224
     * @param string $redirect Set the redirect.
225
     */
226
    public function setRedirect($redirect)
227
    {
228
        $this->redirect = $redirect;
229
    }
230
231
    /**
232
     * @return string representation of any errors encountered.
233
     */
234
    public function getErrors()
235
    {
236
        return $this->errors;
237
    }
238
239
    /**
240
     * @param string $errors Set errors.
241
     */
242
    public function setErrors($errors)
243
    {
244
        $this->errors = $errors;
245
    }
246
247
    /**
248
     * @return int A count of the total number of records in this search and navigation state.
249
     */
250
    public function getTotalRecordCount()
251
    {
252
        return $this->totalRecordCount;
253
    }
254
255
    /**
256
     * @param int $totalRecordCount Set the total record count.
257
     */
258
    public function setTotalRecordCount($totalRecordCount)
259
    {
260
        $this->totalRecordCount = $totalRecordCount;
261
    }
262
263
    /**
264
     * @return Metadata[] A list of metadata as set in the area management section of the command center.
265
     */
266
    public function getSiteParams()
267
    {
268
        return $this->siteParams;
269
    }
270
271
    /**
272
     * @param Metadata[] $siteParams Set the site metadata.
273
     */
274
    public function setSiteParams($siteParams)
275
    {
276
        $this->siteParams = $siteParams;
277
    }
278
279
    /**
280
     * @return string The query sent to the bridge.
281
     */
282
    public function getQuery()
283
    {
284
        return $this->query;
285
    }
286
287
    /**
288
     * @param string $query Sets the query to the bridge.
289
     */
290
    public function setQuery($query)
291
    {
292
        $this->query = $query;
293
    }
294
295
    /**
296
     * @return string The original query sent to the search service.
297
     */
298
    public function getOriginalQuery()
299
    {
300
        return $this->originalQuery;
301
    }
302
303
    /**
304
     * @param string $originalQuery Sets the original query sent to the search service.
305
     */
306
    public function setOriginalQuery($originalQuery)
307
    {
308
        $this->originalQuery = $originalQuery;
309
    }
310
311
    /**
312
     * @return string The corrected query sent to the engine, if auto-correction is enabled.
313
     */
314
    public function getCorrectedQuery()
315
    {
316
        return $this->correctedQuery;
317
    }
318
319
    /**
320
     * @param string $correctedQuery Sets the corrected query sent to the engine, if auto-correction is enabled.
321
     */
322
    public function setCorrectedQuery($correctedQuery)
323
    {
324
        $this->correctedQuery = $correctedQuery;
325
    }
326
327
    /**
328
     * @return string[] A list of rewrites (spellings, synonyms, etc...) that occurred.
329
     */
330
    public function getRewrites()
331
    {
332
        return $this->rewrites;
333
    }
334
335
    /**
336
     * @param string[] $rewrites Sets the rewrites that occurred.
337
     */
338
    public function setRewrites($rewrites)
339
    {
340
        $this->rewrites = $rewrites;
341
    }
342
343
    /**
344
     * @return string The area that the search fired against.
345
     */
346
    public function getArea()
347
    {
348
        return $this->area;
349
    }
350
351
    /**
352
     * @param string $area Sets the area.
353
     */
354
    public function setArea($area)
355
    {
356
        $this->area = $area;
357
    }
358
359
    /**
360
     * @return string
361
     */
362
    public function getBiasingProfile()
363
    {
364
        return $this->biasingProfile;
365
    }
366
367
    /**
368
     * @param string $biasingProfile
369
     */
370
    public function setBiasingProfile($biasingProfile)
371
    {
372
        $this->biasingProfile = $biasingProfile;
373
    }
374
375
    /**
376
     * @return string[]
377
     */
378
    public function getWarnings()
379
    {
380
      return $this->warnings;
381
    }
382
383
    /**
384
     * @param string[] $warnings
385
     */
386
    public function setWarnings($warnings)
387
    {
388
      $this->warnings = $warnings;
389
    }
390
}
391
392