com.atlassian.confluence.search.v2
Interface ResultFilter

All Known Implementing Classes:
HandleBasedSubsetResultFilter, SubsetResultFilter

public interface ResultFilter

Represents some method for filtering search results before they are returned from the search subsystem. Result filters


Method Summary
 java.lang.String getKey()
          Gets the unique key that identifies this type of result filter.
 java.util.List getParameters()
          Gets the parameters that configure this result filter.
 

Method Detail

getKey

java.lang.String getKey()
Gets the unique key that identifies this type of result filter.

Returns:
the filter key

getParameters

java.util.List getParameters()
Gets the parameters that configure this result filter. Parameters should either be strings, or ResultFilter implementations.

Returns:
the filter parameters


Copyright © 2003-2011 Atlassian. All Rights Reserved.