java.lang.Object | |
↳ | com.atlassian.confluence.search.v2.filter.SubsetResultFilter |
A result filter that filters out all but a particular "window" (startOffset from start, count) of results. Depending on the number of results in the hit set being filtered, there may be fewer than count results returned, or even none at all.
Can also be used, with a startOffset of 0, to return the first 'n' results
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | KEY |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Construct a filter that returns at most the first
count hits. | |||||||||||
Construct a filter with the given start offset and count.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Gets the unique key that identifies this type of result filter.
| |||||||||||
Gets the maximum number of results the filter should allow through
| |||||||||||
Gets the parameters that configure this result filter.
| |||||||||||
Gets the offset of the first search result to return
| |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.confluence.search.v2.ResultFilter
|
Construct a filter that returns at most the first count
hits. This is the
equivalent of new SubsetResultFilter(0, maxResults)
.
maxResults | the number of hits to return |
---|
Construct a filter with the given start offset and count. Offsets are zero-based, so an offset of 0 means "start at the first hit".
startOffset | the zero-based offset of the first hit to return |
---|---|
maxResults | the maximum number of hits to return |
Gets the unique key that identifies this type of result filter.
Gets the maximum number of results the filter should allow through
Gets the parameters that configure this result filter. Parameters should either be strings, or ResultFilter implementations.
Gets the offset of the first search result to return