com.atlassian.confluence.search.v2.searchfilter
Class SearchResultTypeSearchFilter

java.lang.Object
  extended by com.atlassian.confluence.search.v2.AbstractChainableSearchFilter
      extended by com.atlassian.confluence.search.v2.searchfilter.SearchResultTypeSearchFilter
All Implemented Interfaces:
SearchFilter

public class SearchResultTypeSearchFilter
extends AbstractChainableSearchFilter

Filter by SearchResultType. This should NOT be considered part of the public API. Please use ContentSearch or ChangesSearch instead.


Field Summary
static SearchResultTypeSearchFilter CHANGES
          A filter that restricts search results to documents of type SearchResultType.CHANGE.
static SearchResultTypeSearchFilter CONTENT
          A filter that restricts search results to documents of type SearchResultType.CONTENT.
 
Method Summary
static SearchResultTypeSearchFilter getInstance(SearchResultType searchResultType)
          Returns a SearchResultTypeSearchFilter of the specified type.
 String getKey()
           
 SearchResultType getResultType()
           
 
Methods inherited from class com.atlassian.confluence.search.v2.AbstractChainableSearchFilter
and, or
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTENT

public static final SearchResultTypeSearchFilter CONTENT
A filter that restricts search results to documents of type SearchResultType.CONTENT. For Confluence internal use only. Please use ContentSearch instead.


CHANGES

public static final SearchResultTypeSearchFilter CHANGES
A filter that restricts search results to documents of type SearchResultType.CHANGE. For Confluence internal use only. Please use ChangesSearch instead.

Method Detail

getInstance

public static SearchResultTypeSearchFilter getInstance(SearchResultType searchResultType)
Returns a SearchResultTypeSearchFilter of the specified type.

Parameters:
searchResultType - could be either CONTENT or CHANGES. Cannot be null.
Returns:
a SearchResultTypeSearchFilter

getResultType

public SearchResultType getResultType()

getKey

public String getKey()
Returns:
the plugin key


Copyright © 2003–2015 Atlassian. All rights reserved.