java.lang.Object
- com.funnelback.publicui.search.model.padre.ResultsSummary

```
public class ResultsSummary
extends Object
```
Search result summary, with document counts and information about the current page returned.

Since:

11.0

Field Summary

Fields
Modifier and Type	Field	Description
`private boolean`	`anyUrlsPromoted`	Are any URLs promoted (includes URLs that may have been later removed or collapsed).
`private Integer`	`carriedOverFtd`	Number of events continued from the day when using event search.
`private Integer`	`collapsed`	Number of collapsed results
`private Integer`	`currEnd`	Current offset of the last result returned.
`private Integer`	`currStart`	Current offset of the first result returned.
`private Boolean`	`estimatedCounts`	Whether or not the counts within this summary have been estimated.
`private Integer`	`fullyMatching`	Number of documents that fully matched the query terms.
`private Integer`	`nextStart`	Offset of the first result of the next page of results.
`private Integer`	`numRanks`	Number of results returned.
`private Integer`	`partiallyMatching`	Number of documents that partially matched the query terms.
`private Integer`	`prevStart`	Offset of the first result of the previous page of results.
`private boolean`	`resultDiversificationApplied`	Was any result afected by result diversification.
`private Integer`	`totalDistinctMatchingUrls`	Number of distinct URLs when using event search.
`private Integer`	`totalMatching`	Total number of documents matching the query terms, fully or partially.
`private Integer`	`totalSecurityObscuredUrls`	The number of results which are not viewable to the user

Constructor Summary

Constructors
Constructor	Description
`ResultsSummary()`
`ResultsSummary(Integer fullyMatching, Integer collapsed, Integer partiallyMatching, Integer totalMatching, Boolean estimatedCounts, Integer carriedOverFtd, Integer totalDistinctMatchingUrls, Integer numRanks, Integer currStart, Integer currEnd, Integer prevStart, Integer nextStart, Integer totalSecurityObscuredUrls, boolean anyUrlsPromoted, boolean resultDiversificationApplied)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Integer`	`getCarriedOverFtd()`	Number of events continued from the day when using event search.
`Integer`	`getCollapsed()`	Number of collapsed results
`Integer`	`getCurrEnd()`	Current offset of the last result returned.
`Integer`	`getCurrStart()`	Current offset of the first result returned.
`Boolean`	`getEstimatedCounts()`	Whether or not the counts within this summary have been estimated.
`Integer`	`getFullyMatching()`	Number of documents that fully matched the query terms.
`Integer`	`getNextStart()`	Offset of the first result of the next page of results.
`Integer`	`getNumRanks()`	Number of results returned.
`Integer`	`getPartiallyMatching()`	Number of documents that partially matched the query terms.
`Integer`	`getPrevStart()`	Offset of the first result of the previous page of results.
`Integer`	`getTotalDistinctMatchingUrls()`	Number of distinct URLs when using event search.
`Integer`	`getTotalMatching()`	Total number of documents matching the query terms, fully or partially.
`Integer`	`getTotalSecurityObscuredUrls()`	The number of results which are not viewable to the user
`boolean`	`isAnyUrlsPromoted()`	Are any URLs promoted (includes URLs that may have been later removed or collapsed).
`boolean`	`isResultDiversificationApplied()`	Was any result afected by result diversification.
`void`	`setAnyUrlsPromoted(boolean anyUrlsPromoted)`	Are any URLs promoted (includes URLs that may have been later removed or collapsed).
`void`	`setCarriedOverFtd(Integer carriedOverFtd)`	Number of events continued from the day when using event search.
`void`	`setCollapsed(Integer collapsed)`	Number of collapsed results
`void`	`setCurrEnd(Integer currEnd)`	Current offset of the last result returned.
`void`	`setCurrStart(Integer currStart)`	Current offset of the first result returned.
`void`	`setEstimatedCounts(Boolean estimatedCounts)`	Whether or not the counts within this summary have been estimated.
`void`	`setFullyMatching(Integer fullyMatching)`	Number of documents that fully matched the query terms.
`void`	`setNextStart(Integer nextStart)`	Offset of the first result of the next page of results.
`void`	`setNumRanks(Integer numRanks)`	Number of results returned.
`void`	`setPartiallyMatching(Integer partiallyMatching)`	Number of documents that partially matched the query terms.
`void`	`setPrevStart(Integer prevStart)`	Offset of the first result of the previous page of results.
`void`	`setResultDiversificationApplied(boolean resultDiversificationApplied)`	Was any result afected by result diversification.
`void`	`setTotalDistinctMatchingUrls(Integer totalDistinctMatchingUrls)`	Number of distinct URLs when using event search.
`void`	`setTotalMatching(Integer totalMatching)`	Total number of documents matching the query terms, fully or partially.
`void`	`setTotalSecurityObscuredUrls(Integer totalSecurityObscuredUrls)`	The number of results which are not viewable to the user

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

- Field Detail
  - fullyMatching
```
private Integer fullyMatching
```
    Number of documents that fully matched the query terms.
  - collapsed
```
private Integer collapsed
```
    Number of collapsed results
  - partiallyMatching
```
private Integer partiallyMatching
```
    Number of documents that partially matched the query terms.
  - totalMatching
```
private Integer totalMatching
```
    Total number of documents matching the query terms, fully or partially.
    
    Should be fullyMatching + partiallyMatching.
  - estimatedCounts
```
private Boolean estimatedCounts
```
    Whether or not the counts within this summary have been estimated.
    
    Estimation occurs when the result set is only partially scanned (e.g. more results are found than the daat value).
  - carriedOverFtd
```
private Integer carriedOverFtd
```
    Number of events continued from the day when using event search.
    
    See the -events query processor options.
  - totalDistinctMatchingUrls
```
private Integer totalDistinctMatchingUrls
```
    Number of distinct URLs when using event search.
    
    See the -events query processor options.
  - numRanks
```
private Integer numRanks
```
    Number of results returned.
  - currStart
```
private Integer currStart
```
    Current offset of the first result returned.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 11.
    
    See: start_rank parameter, num_ranks parameter.
  - currEnd
```
private Integer currEnd
```
    Current offset of the last result returned.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 20.
    
    See: start_rank parameter, num_ranks parameter.
  - prevStart
```
private Integer prevStart
```
    Offset of the first result of the previous page of results.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 1.
    
    See: start_rank parameter, num_ranks parameter.
  - nextStart
```
private Integer nextStart
```
    Offset of the first result of the next page of results.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 21.
    
    See: start_rank parameter, num_ranks parameter.
  - totalSecurityObscuredUrls
```
private Integer totalSecurityObscuredUrls
```
    The number of results which are not viewable to the user
    
    Only set when Translucent DLS is enabled.
  - anyUrlsPromoted
```
private boolean anyUrlsPromoted
```
    Are any URLs promoted (includes URLs that may have been later removed or collapsed).
    
    Since:
    
    15.12
  - resultDiversificationApplied
```
private boolean resultDiversificationApplied
```
    Was any result afected by result diversification.
    
    Since:
    
    15.12
- Constructor Detail
  - ResultsSummary
```
public ResultsSummary(Integer fullyMatching,
                      Integer collapsed,
                      Integer partiallyMatching,
                      Integer totalMatching,
                      Boolean estimatedCounts,
                      Integer carriedOverFtd,
                      Integer totalDistinctMatchingUrls,
                      Integer numRanks,
                      Integer currStart,
                      Integer currEnd,
                      Integer prevStart,
                      Integer nextStart,
                      Integer totalSecurityObscuredUrls,
                      boolean anyUrlsPromoted,
                      boolean resultDiversificationApplied)
```
  - ResultsSummary
```
public ResultsSummary()
```
- Method Detail
  - getFullyMatching
```
public Integer getFullyMatching()
```
    Number of documents that fully matched the query terms.
  - setFullyMatching
```
public void setFullyMatching(Integer fullyMatching)
```
    Number of documents that fully matched the query terms.
  - getCollapsed
```
public Integer getCollapsed()
```
    Number of collapsed results
  - setCollapsed
```
public void setCollapsed(Integer collapsed)
```
    Number of collapsed results
  - getPartiallyMatching
```
public Integer getPartiallyMatching()
```
    Number of documents that partially matched the query terms.
  - setPartiallyMatching
```
public void setPartiallyMatching(Integer partiallyMatching)
```
    Number of documents that partially matched the query terms.
  - getTotalMatching
```
public Integer getTotalMatching()
```
    Total number of documents matching the query terms, fully or partially.
    
    Should be fullyMatching + partiallyMatching.
  - setTotalMatching
```
public void setTotalMatching(Integer totalMatching)
```
    Total number of documents matching the query terms, fully or partially.
    
    Should be fullyMatching + partiallyMatching.
  - getEstimatedCounts
```
public Boolean getEstimatedCounts()
```
    Whether or not the counts within this summary have been estimated.
    
    Estimation occurs when the result set is only partially scanned (e.g. more results are found than the daat value).
  - setEstimatedCounts
```
public void setEstimatedCounts(Boolean estimatedCounts)
```
    Whether or not the counts within this summary have been estimated.
    
    Estimation occurs when the result set is only partially scanned (e.g. more results are found than the daat value).
  - getCarriedOverFtd
```
public Integer getCarriedOverFtd()
```
    Number of events continued from the day when using event search.
    
    See the -events query processor options.
  - setCarriedOverFtd
```
public void setCarriedOverFtd(Integer carriedOverFtd)
```
    Number of events continued from the day when using event search.
    
    See the -events query processor options.
  - getTotalDistinctMatchingUrls
```
public Integer getTotalDistinctMatchingUrls()
```
    Number of distinct URLs when using event search.
    
    See the -events query processor options.
  - setTotalDistinctMatchingUrls
```
public void setTotalDistinctMatchingUrls(Integer totalDistinctMatchingUrls)
```
    Number of distinct URLs when using event search.
    
    See the -events query processor options.
  - getNumRanks
```
public Integer getNumRanks()
```
    Number of results returned.
  - setNumRanks
```
public void setNumRanks(Integer numRanks)
```
    Number of results returned.
  - getCurrStart
```
public Integer getCurrStart()
```
    Current offset of the first result returned.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 11.
    
    See: start_rank parameter, num_ranks parameter.
  - setCurrStart
```
public void setCurrStart(Integer currStart)
```
    Current offset of the first result returned.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 11.
    
    See: start_rank parameter, num_ranks parameter.
  - getCurrEnd
```
public Integer getCurrEnd()
```
    Current offset of the last result returned.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 20.
    
    See: start_rank parameter, num_ranks parameter.
  - setCurrEnd
```
public void setCurrEnd(Integer currEnd)
```
    Current offset of the last result returned.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 20.
    
    See: start_rank parameter, num_ranks parameter.
  - getPrevStart
```
public Integer getPrevStart()
```
    Offset of the first result of the previous page of results.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 1.
    
    See: start_rank parameter, num_ranks parameter.
  - setPrevStart
```
public void setPrevStart(Integer prevStart)
```
    Offset of the first result of the previous page of results.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 1.
    
    See: start_rank parameter, num_ranks parameter.
  - getNextStart
```
public Integer getNextStart()
```
    Offset of the first result of the next page of results.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 21.
    
    See: start_rank parameter, num_ranks parameter.
  - setNextStart
```
public void setNextStart(Integer nextStart)
```
    Offset of the first result of the next page of results.
    
    For example if the second page of results were returned and 10 results were requested, this will be set to 21.
    
    See: start_rank parameter, num_ranks parameter.
  - getTotalSecurityObscuredUrls
```
public Integer getTotalSecurityObscuredUrls()
```
    The number of results which are not viewable to the user
    
    Only set when Translucent DLS is enabled.
  - setTotalSecurityObscuredUrls
```
public void setTotalSecurityObscuredUrls(Integer totalSecurityObscuredUrls)
```
    The number of results which are not viewable to the user
    
    Only set when Translucent DLS is enabled.
  - isAnyUrlsPromoted
```
public boolean isAnyUrlsPromoted()
```
    Are any URLs promoted (includes URLs that may have been later removed or collapsed).
    
    Since:
    
    15.12
  - setAnyUrlsPromoted
```
public void setAnyUrlsPromoted(boolean anyUrlsPromoted)
```
    Are any URLs promoted (includes URLs that may have been later removed or collapsed).
    
    Since:
    
    15.12
  - isResultDiversificationApplied
```
public boolean isResultDiversificationApplied()
```
    Was any result afected by result diversification.
    
    Since:
    
    15.12
  - setResultDiversificationApplied
```
public void setResultDiversificationApplied(boolean resultDiversificationApplied)
```
    Was any result afected by result diversification.
    
    Since:
    
    15.12

Class ResultsSummary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fullyMatching

collapsed

partiallyMatching

totalMatching

estimatedCounts

carriedOverFtd

totalDistinctMatchingUrls

numRanks

currStart

currEnd

prevStart

nextStart

totalSecurityObscuredUrls

anyUrlsPromoted

resultDiversificationApplied

Constructor Detail

ResultsSummary

ResultsSummary

Method Detail

getFullyMatching

setFullyMatching

getCollapsed

setCollapsed

getPartiallyMatching

setPartiallyMatching

getTotalMatching

setTotalMatching

getEstimatedCounts

setEstimatedCounts

getCarriedOverFtd

setCarriedOverFtd

getTotalDistinctMatchingUrls

setTotalDistinctMatchingUrls

getNumRanks

setNumRanks

getCurrStart

setCurrStart

getCurrEnd

setCurrEnd

getPrevStart

setPrevStart

getNextStart

setNextStart

getTotalSecurityObscuredUrls

setTotalSecurityObscuredUrls

isAnyUrlsPromoted

setAnyUrlsPromoted

isResultDiversificationApplied

setResultDiversificationApplied