AbstractResults (GroupBy - API - Java

java.lang.Object
- com.groupbyinc.api.model.AbstractResults<R,T>

Direct Known Subclasses:

BaseResults
```
public abstract class AbstractResults<R extends AbstractRecord<R>,T extends AbstractResults<R,T>>
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.util.List<Cluster>`	`clusters`
`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<R>`	`records`
`protected java.lang.String`	`redirect`
`protected java.util.List<Navigation>`	`selectedNavigation`
`protected java.util.List<Metadata>`	`siteParams`
`protected Template`	`template`
`protected long`	`totalRecordCount`

Constructor Summary

Constructors
Constructor and Description

AbstractResults()

Constructors
Constructor and Description
`AbstractResults()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getArea()`
`java.util.List<Navigation>`	`getAvailableNavigation()`
`java.lang.String`	`getBiasingProfile()`
`java.util.List<Cluster>`	`getClusters()` `A cluster represents a set of documents that are considered closely related based on a search term.`
`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<R>`	`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()`
`T`	`setArea(java.lang.String pArea)`
`T`	`setAvailableNavigation(java.util.List<Navigation> availableNavigation)`
`T`	`setBiasingProfile(java.lang.String biasingProfile)`
`T`	`setClusters(java.util.List<Cluster> clusters)`
`T`	`setCorrectedQuery(java.lang.String correctedQuery)`
`T`	`setDidYouMean(java.util.List<java.lang.String> didYouMean)`
`T`	`setErrors(java.lang.String errors)`
`T`	`setOriginalQuery(java.lang.String originalQuery)`
`T`	`setPageInfo(PageInfo pageInfo)`
`T`	`setQuery(java.lang.String query)`
`T`	`setRecords(java.util.List<R> records)`
`T`	`setRedirect(java.lang.String redirect)`
`T`	`setRelatedQueries(java.util.List<java.lang.String> relatedQueries)`
`T`	`setRewrites(java.util.List<java.lang.String> rewrites)`
`T`	`setSelectedNavigation(java.util.List<Navigation> selectedNavigation)`
`T`	`setSiteParams(java.util.List<Metadata> siteParams)`
`T`	`setTemplate(Template template)`
`T`	`setTotalRecordCount(long totalRecordCount)`

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
```
  - availableNavigation
```
protected java.util.List<Navigation> availableNavigation
```
  - selectedNavigation
```
protected java.util.List<Navigation> selectedNavigation
```
  - records
```
protected java.util.List<R extends AbstractRecord<R>> records
```
  - didYouMean
```
protected java.util.List<java.lang.String> didYouMean
```
  - siteParams
```
protected java.util.List<Metadata> siteParams
```
  - clusters
```
protected java.util.List<Cluster> clusters
```
- Constructor Detail
  - AbstractResults
```
public AbstractResults()
```
- Method Detail
  - getArea
```
public java.lang.String getArea()
```
    Returns:
    
    The area that the query was run against.
  - setArea
```
public T setArea(java.lang.String pArea)
```
    Parameters:
    
    pArea - 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 T 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 T setRelatedQueries(java.util.List<java.lang.String> relatedQueries)
```
    Parameters:
    
    relatedQueries - Set the related queries for a search term
    
    Returns:
  - getRecords
```
public java.util.List<R> getRecords()
```
    Returns:
    
    A list of the records for this search and navigation state.
  - setRecords
```
public T setRecords(java.util.List<R> 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 T setTemplate(Template template)
```
    Parameters:
    
    template - Set the template
    
    Returns:
  - getPageInfo
```
public PageInfo getPageInfo()
```
    Returns:
    
    Information about the results page.
  - setPageInfo
```
public T 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 T 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.
  - getSelectedNavigationJson
```
public java.lang.String getSelectedNavigationJson()
```
    Returns:
    
    A JSON-formatted string representing the selected refinements.
  - setSelectedNavigation
```
public T setSelectedNavigation(java.util.List<Navigation> selectedNavigation)
```
    Parameters:
    
    selectedNavigation - Set the selected refinements
    
    Returns:
  - 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 T 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 T 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 T setTotalRecordCount(long totalRecordCount)
```
    Parameters:
    
    totalRecordCount - Set the total record count.
    
    Returns:
  - getClusters
```
public java.util.List<Cluster> getClusters()
```
    A cluster represents a set of documents that are considered closely related based on a search term. This object will only be populated if you use the bridge.searchCluster
    
    Returns:
    
    The list of clusters.
  - setClusters
```
public T setClusters(java.util.List<Cluster> clusters)
```
    Parameters:
    
    clusters - Set the search clusters.
    
    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 T 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 T 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 T 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 T 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 T setRewrites(java.util.List<java.lang.String> rewrites)
```
    Parameters:
    
    rewrites - Set the rewrites that occurred
    
    Returns:
  - getBiasingProfile
```
public java.lang.String getBiasingProfile()
```
  - setBiasingProfile
```
public T setBiasingProfile(java.lang.String biasingProfile)
```

Class AbstractResults<R extends AbstractRecord<R>,T extends AbstractResults<R,T>>

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

availableNavigation

selectedNavigation

records

didYouMean

siteParams

clusters

Constructor Detail

AbstractResults

Method Detail

getArea

setArea

getDidYouMean

setDidYouMean

getRelatedQueries

setRelatedQueries

getRecords

setRecords

getTemplate

setTemplate

getPageInfo

setPageInfo

getAvailableNavigation

setAvailableNavigation

getSelectedNavigation

getSelectedNavigationJson

setSelectedNavigation

getRedirect

setRedirect

getErrors

setErrors

getTotalRecordCount

setTotalRecordCount

getClusters

setClusters

getSiteParams

setSiteParams

getOriginalQuery

setOriginalQuery

getCorrectedQuery

setCorrectedQuery

getQuery

setQuery

getRewrites

setRewrites

getBiasingProfile

setBiasingProfile