Completed
Push — SR-1041 ( ff7836...87784f )
by
unknown
01:32
created

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