com.atlassian.confluence.search.v2
Class Search

java.lang.Object
  com.atlassian.confluence.search.v2.Search

public class Search
extends java.lang.Object

A representation of a search to be performed. Searches are immutable, and consist of three parts:

1. The query to be performed
2. The sort order to apply to the results
3. A resultFilter to allow efficient results post-processing from within the search operation.

Constructor Summary

Search(SearchQuery query, SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter)
Construct a new Search.

Method Summary

boolean	equals(java.lang.Object obj)
SearchQuery	getQuery() Gets the query component of the search
ResultFilter	getResultFilter() Gets the results filter component of the search
SearchFilter	getSearchFilter()
SearchSort	getSort() Gets the sort component of the search
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Search

public Search(SearchQuery query,
              SearchSort sort,
              SearchFilter searchFilter,
              ResultFilter resultFilter)

Construct a new Search.

Parameters:

query - the query to perform

sort - how to order the results

searchFilter - filter that performs filtering during search

resultFilter - filter that performs filtering the results after a search has complete

Method Detail

getQuery

public SearchQuery getQuery()

Gets the query component of the search

Returns:

the search query

getSort

public SearchSort getSort()

Gets the sort component of the search

Returns:

the search sort

getSearchFilter

public SearchFilter getSearchFilter()

Returns:

the search filter

getResultFilter

public ResultFilter getResultFilter()

Gets the results filter component of the search

Returns:

the results filter

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object