com.atlassian.confluence.search.v2

Interface ResultFilter

All Known Implementing Classes:

SubsetResultFilter

Deprecated.

since 5.5. Please consider implemeting SearchFilter. If you must perform post search filtering, you can filter SearchResults returned by the methods on SearchManager.

@Deprecated
public interface ResultFilter

Represents a filter that is applied to search results after a search is complete. This is mapped to a LuceneResultFilter which implements the actual filtering behaviour.

Please note, this is different to a SearchFilter which represents a filter that is applied during a search (which is generally more efficient).

Method Summary

Modifier and Type	Method and Description
String	getKey() Deprecated. Gets the unique key that identifies this type of result filter.
List	getParameters() Deprecated. Gets the parameters that configure this result filter.

Method Detail

getKey

String getKey()

Deprecated.

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

Returns:

the filter key

getParameters

List getParameters()

Deprecated.

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

Returns:

the filter parameters