Completed
Push — SR-1041 ( 40e5b1...68e681 )
by
unknown
02:04
created

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