Results (GroupBy - API - Java 2.2.64 API)

java.lang.Object
- com.groupbyinc.api.model.Results

```
public class Results
extends java.lang.Object
```
The results object contains a reference to all the objects that come back from the search service.

Author:

will

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`area`
`protected java.util.List<Navigation>`	`availableNavigation`
`protected java.lang.String`	`biasingProfile`
`protected java.lang.String`	`correctedQuery`
`protected java.util.List<java.lang.String>`	`didYouMean`
`protected java.lang.String`	`errors`
`protected java.lang.String`	`originalQuery`
`protected PageInfo`	`pageInfo`
`protected java.lang.String`	`query`
`protected java.util.List<Record>`	`records`
`protected java.lang.String`	`redirect`
`protected java.util.List<Navigation>`	`selectedNavigation`
`protected java.util.List<Metadata>`	`siteParams`
`protected Template`	`template`
`protected long`	`totalRecordCount`
`protected java.util.List<java.lang.String>`	`warnings`

Constructor Summary

Constructors
Constructor and Description

Results()

Constructors
Constructor and Description
`Results()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Results`	`addWarning(java.lang.String warning)`
`Results`	`addWarnings(java.util.Collection<java.lang.String> warnings)`
`java.lang.String`	`getArea()`
`java.util.List<Navigation>`	`getAvailableNavigation()`
`java.lang.String`	`getBiasingProfile()`
`java.lang.String`	`getCorrectedQuery()`
`java.util.List<java.lang.String>`	`getDidYouMean()`
`java.lang.String`	`getErrors()`
`java.lang.String`	`getOriginalQuery()`
`PageInfo`	`getPageInfo()`
`java.lang.String`	`getQuery()`
`java.util.List<Record>`	`getRecords()`
`java.lang.String`	`getRedirect()` `Note, if a redirect is triggered the engine does not send back records.`
`java.util.List<java.lang.String>`	`getRelatedQueries()`
`java.util.List<java.lang.String>`	`getRewrites()`
`java.util.List<Navigation>`	`getSelectedNavigation()`
`java.lang.String`	`getSelectedNavigationJson()`
`java.util.List<Metadata>`	`getSiteParams()`
`Template`	`getTemplate()`
`long`	`getTotalRecordCount()`
`java.util.List<java.lang.String>`	`getWarnings()`
`Results`	`setArea(java.lang.String area)`
`Results`	`setAvailableNavigation(java.util.List<Navigation> availableNavigation)`
`Results`	`setBiasingProfile(java.lang.String biasingProfile)`
`Results`	`setCorrectedQuery(java.lang.String correctedQuery)`
`Results`	`setDidYouMean(java.util.List<java.lang.String> didYouMean)`
`Results`	`setErrors(java.lang.String errors)`
`Results`	`setOriginalQuery(java.lang.String originalQuery)`
`Results`	`setPageInfo(PageInfo pageInfo)`
`Results`	`setQuery(java.lang.String query)`
`Results`	`setRecords(java.util.List<Record> records)`
`Results`	`setRedirect(java.lang.String redirect)`
`Results`	`setRelatedQueries(java.util.List<java.lang.String> relatedQueries)`
`Results`	`setRewrites(java.util.List<java.lang.String> rewrites)`
`Results`	`setSelectedNavigation(java.util.List<Navigation> selectedNavigation)`
`Results`	`setSiteParams(java.util.List<Metadata> siteParams)`
`Results`	`setTemplate(Template template)`
`Results`	`setTotalRecordCount(long totalRecordCount)`
`Results`	`setWarnings(java.util.List<java.lang.String> warnings)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - totalRecordCount
```
protected long totalRecordCount
```
  - area
```
protected java.lang.String area
```
  - biasingProfile
```
protected java.lang.String biasingProfile
```
  - redirect
```
protected java.lang.String redirect
```
  - errors
```
protected java.lang.String errors
```
  - query
```
protected java.lang.String query
```
  - originalQuery
```
protected java.lang.String originalQuery
```
  - correctedQuery
```
protected java.lang.String correctedQuery
```
  - template
```
protected Template template
```
  - pageInfo
```
protected PageInfo pageInfo
```
  - warnings
```
protected java.util.List<java.lang.String> warnings
```
  - availableNavigation
```
protected java.util.List<Navigation> availableNavigation
```
  - selectedNavigation
```
protected java.util.List<Navigation> selectedNavigation
```
  - records
```
protected java.util.List<Record> records
```
  - didYouMean
```
protected java.util.List<java.lang.String> didYouMean
```
  - siteParams
```
protected java.util.List<Metadata> siteParams
```
- Constructor Detail
  - Results
```
public Results()
```
- Method Detail
  - getArea
```
public java.lang.String getArea()
```
    Returns:
    
    The area that the query was run against.
  - setArea
```
public Results setArea(java.lang.String area)
```
    Parameters:
    
    area - Set the area to run the query against
    
    Returns:
  - getDidYouMean
```
public java.util.List<java.lang.String> getDidYouMean()
```
    Returns:
    
    A list of spell corrections based on the search term.
  - setDidYouMean
```
public Results setDidYouMean(java.util.List<java.lang.String> didYouMean)
```
    Parameters:
    
    didYouMean - Set the list
    
    Returns:
  - getRelatedQueries
```
public java.util.List<java.lang.String> getRelatedQueries()
```
    Returns:
    
    A Related Query object containing a list of related queries for a given search term e.g. searchTerm :- pizza, relatedQueries :- pepperoni, cheese, vegetables, stuff crust
  - setRelatedQueries
```
public Results setRelatedQueries(java.util.List<java.lang.String> relatedQueries)
```
    Parameters:
    
    relatedQueries - Set the related queries for a search term
    
    Returns:
  - getRecords
```
public java.util.List<Record> getRecords()
```
    Returns:
    
    A list of the records for this search and navigation state.
  - setRecords
```
public Results setRecords(java.util.List<Record> records)
```
    Parameters:
    
    records - Set the records.
    
    Returns:
  - getTemplate
```
public Template getTemplate()
```
    Returns:
    
    If a rule has fired a template will be returned specified in the rule.
  - setTemplate
```
public Results setTemplate(Template template)
```
    Parameters:
    
    template - Set the template
    
    Returns:
  - getPageInfo
```
public PageInfo getPageInfo()
```
    Returns:
    
    Information about the results page.
  - setPageInfo
```
public Results setPageInfo(PageInfo pageInfo)
```
    Parameters:
    
    pageInfo - Set the page info
    
    Returns:
  - getAvailableNavigation
```
public java.util.List<Navigation> getAvailableNavigation()
```
    Returns:
    
    A list of all the ways in which you can filter the current result set.
  - setAvailableNavigation
```
public Results setAvailableNavigation(java.util.List<Navigation> availableNavigation)
```
    Parameters:
    
    availableNavigation - Set the available navigation.
    
    Returns:
  - getSelectedNavigation
```
public java.util.List<Navigation> getSelectedNavigation()
```
    Returns:
    
    A list of the currently selected refinements. Also known as breadcrumbs.
  - setSelectedNavigation
```
public Results setSelectedNavigation(java.util.List<Navigation> selectedNavigation)
```
    Parameters:
    
    selectedNavigation - Set the selected refinements
    
    Returns:
  - getSelectedNavigationJson
```
public java.lang.String getSelectedNavigationJson()
```
    Returns:
    
    A JSON-formatted string representing the selected refinements.
  - getRedirect
```
public java.lang.String getRedirect()
```
    Note, if a redirect is triggered the engine does not send back records.
    
    Returns:
    
    A URL to redirect to based on this search term.
  - setRedirect
```
public Results setRedirect(java.lang.String redirect)
```
    Parameters:
    
    redirect - Set the redirect
    
    Returns:
  - getErrors
```
public java.lang.String getErrors()
```
    Returns:
    
    String representation of any errors encountered.
  - setErrors
```
public Results setErrors(java.lang.String errors)
```
    Parameters:
    
    errors - Set errors.
    
    Returns:
  - getTotalRecordCount
```
public long getTotalRecordCount()
```
    Returns:
    
    A count of the total number of records in this search and navigation state.
  - setTotalRecordCount
```
public Results setTotalRecordCount(long totalRecordCount)
```
    Parameters:
    
    totalRecordCount - Set the total record count.
    
    Returns:
  - getSiteParams
```
public java.util.List<Metadata> getSiteParams()
```
    Returns:
    
    A list of metadata as set in the area management section of the command center.
  - setSiteParams
```
public Results setSiteParams(java.util.List<Metadata> siteParams)
```
    Parameters:
    
    siteParams - Set the site metadata
    
    Returns:
  - getOriginalQuery
```
public java.lang.String getOriginalQuery()
```
    Returns:
    
    The original query sent to the search service
  - setOriginalQuery
```
public Results setOriginalQuery(java.lang.String originalQuery)
```
    Parameters:
    
    originalQuery - Sets the original query sent to the search service
    
    Returns:
  - getCorrectedQuery
```
public java.lang.String getCorrectedQuery()
```
    Returns:
    
    The corrected query sent to the engine, if auto-correction is enabled
  - setCorrectedQuery
```
public Results setCorrectedQuery(java.lang.String correctedQuery)
```
    Parameters:
    
    correctedQuery - Sets the corrected query sent to the engine, if auto-correction is enabled
    
    Returns:
  - getQuery
```
public java.lang.String getQuery()
```
    Returns:
    
    The query sent to the engine, after query rewrites are applied
  - setQuery
```
public Results setQuery(java.lang.String query)
```
    Parameters:
    
    query - Sets the query sent to the engine, after query rewrites are applied
    
    Returns:
  - getRewrites
```
public java.util.List<java.lang.String> getRewrites()
```
    Returns:
    
    A list of rewrites (spellings, synonyms, etc...) that occurred.
  - setRewrites
```
public Results setRewrites(java.util.List<java.lang.String> rewrites)
```
    Parameters:
    
    rewrites - Set the rewrites that occurred
    
    Returns:
  - getBiasingProfile
```
public java.lang.String getBiasingProfile()
```
    Returns:
    
    The biasing profile in effect.
  - setBiasingProfile
```
public Results setBiasingProfile(java.lang.String biasingProfile)
```
    Parameters:
    
    biasingProfile - Set the biasing profile in effect
    
    Returns:
  - getWarnings
```
public java.util.List<java.lang.String> getWarnings()
```
    Returns:
    
    A list of warnings encountered.
  - setWarnings
```
public Results setWarnings(java.util.List<java.lang.String> warnings)
```
    Parameters:
    
    warnings - Set warnings.
    
    Returns:
  - addWarnings
```
public Results addWarnings(java.util.Collection<java.lang.String> warnings)
```
    Parameters:
    
    warnings - The warnings to add
    
    Returns:
  - addWarning
```
public Results addWarning(java.lang.String warning)
```
    Parameters:
    
    warning - The warning to add
    
    Returns:

Class Results

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

totalRecordCount

area

biasingProfile

redirect

errors

query

originalQuery

correctedQuery

template

pageInfo

warnings

availableNavigation

selectedNavigation

records

didYouMean

siteParams

Constructor Detail

Results

Method Detail

getArea

setArea

getDidYouMean

setDidYouMean

getRelatedQueries

setRelatedQueries

getRecords

setRecords

getTemplate

setTemplate

getPageInfo

setPageInfo

getAvailableNavigation

setAvailableNavigation

getSelectedNavigation

setSelectedNavigation

getSelectedNavigationJson

getRedirect

setRedirect

getErrors

setErrors

getTotalRecordCount

setTotalRecordCount

getSiteParams

setSiteParams

getOriginalQuery

setOriginalQuery

getCorrectedQuery

setCorrectedQuery

getQuery

setQuery

getRewrites

setRewrites

getBiasingProfile

setBiasingProfile

getWarnings

setWarnings

addWarnings

addWarning