com.atlassian.confluence.search.v2

Interface ISearch

All Known Subinterfaces:

SearchWithToken

All Known Implementing Classes:

AbstractSearch, ChangesSearch, ContentSearch, DefaultSearch, DefaultSearchWithToken

public interface ISearch

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

1. The Query to be performed
2. The Sort order to apply to the results
3. The ResultFilter to allow filtering of results after the search has completed. (this is deprecated)
4. The SearchFilter to filter search results during search. Prefer this over using a ResultFilter. Search filters are generally more efficient than result filters.

Method Summary

Modifier and Type	Method and Description
default Optional<HightlightParams>	getHighlight() Provides indication as well as pre/post tag whether query terms should be highlighted in title and body of a search result.
int	getLimit()
SearchQuery	getQuery()
ResultFilter	getResultFilter() 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.
SearchFilter	getSearchFilter()
default String	getSearchType() Returns type of search e.g.
SearchSort	getSort()
int	getStartOffset()
default boolean	isExplain()

Method Detail

getQuery

SearchQuery getQuery()

Returns:

the query component of the search

getSort

SearchSort getSort()

Returns:

the sort component of the search

getSearchFilter

SearchFilter getSearchFilter()

Returns:

the search filter component of the search

getResultFilter

@Deprecated
ResultFilter getResultFilter()

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.

Returns the result filter component of the search.

Note: if a non-null ResultFilter is returned here, it will override getStartOffset() and getLimit()

Returns:

the result filter component of the search

getStartOffset

int getStartOffset()

Returns:

the start offset (0 based).

getLimit

int getLimit()

Returns:

the maximum page size

getSearchType

default String getSearchType()

Returns type of search e.g. SiteSearch, RecentUpdate, NetworkFeed, BlogUpdate, which can be used by search manager to switch between different implementations to support incremental roll out.

Returns:

type of search

getHighlight

default Optional<HightlightParams> getHighlight()

Provides indication as well as pre/post tag whether query terms should be highlighted in title and body of a search result. See SearchResult.getDisplayTitleWithHighlights() and SearchResult.getResultExcerptWithHighlights().

isExplain

default boolean isExplain()