com.atlassian.confluence.search.v2.filter
Class HandleBasedSubsetResultFilter

java.lang.Object
  com.atlassian.confluence.search.v2.filter.HandleBasedSubsetResultFilter

All Implemented Interfaces:

ResultFilter

public class HandleBasedSubsetResultFilter
extends Object
implements ResultFilter

Result filter that returns a subset of the total result set starting from the index document that comes after the document with the specified handle.

Constructor Summary

HandleBasedSubsetResultFilter(com.atlassian.bonnie.Handle handle, int pageSize)

Method Summary

com.atlassian.bonnie.Handle	getHandle()
String	getKey() Gets the unique key that identifies this type of result filter.
int	getPageSize()
List	getParameters() Gets the parameters that configure this result filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HandleBasedSubsetResultFilter

public HandleBasedSubsetResultFilter(com.atlassian.bonnie.Handle handle,
                                     int pageSize)

Method Detail

getHandle

public com.atlassian.bonnie.Handle getHandle()

getPageSize

public int getPageSize()

getKey

public String getKey()

Description copied from interface: ResultFilter

Gets the unique key that identifies this type of result filter.

Specified by:

getKey in interface ResultFilter

Returns:

the filter key

getParameters

public List getParameters()

Description copied from interface: ResultFilter

Gets the parameters that configure this result filter. Parameters should either be strings, or ResultFilter implementations.

Specified by:

getParameters in interface ResultFilter

Returns:

the filter parameters