Package com.atlassian.confluence.search.v2

Class CustomSearch

java.lang.Object

com.atlassian.confluence.search.v2.AbstractSearch

com.atlassian.confluence.search.v2.CustomSearch

All Implemented Interfaces:

ISearch

public class CustomSearch
extends AbstractSearch

Represents a search against custom index.

Since:

7.17

Field Summary

Fields inherited from class com.atlassian.confluence.search.v2.AbstractSearch

indexes, limit, query, sort, startOffset

Constructor Summary

Constructors

Constructor	Description
CustomSearch(@NonNull SearchQuery query, SearchSort sort)	Constructs a search against custom indexes.
CustomSearch(@NonNull SearchQuery query, SearchSort sort, int startOffset, int limit)	Constructs a search against custom indexes.

Method Summary

Methods inherited from class com.atlassian.confluence.search.v2.AbstractSearch

equals, getLimit, getQuery, getSearchIndexes, getSort, getStartOffset, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.search.v2.ISearch

getHighlight, getSearchType, isExplain

Constructor Detail

CustomSearch

public CustomSearch(@NonNull SearchQuery query,
                    SearchSort sort)

Constructs a search against custom indexes. The maximum number of results returned will be a system provided default.

Parameters:

query - the non-null query to perform against custom index

sort - how to order the results of the query

Since:

7.20

CustomSearch

public CustomSearch(@NonNull SearchQuery query,
                    SearchSort sort,
                    int startOffset,
                    int limit)

Constructs a search against custom indexes.

Parameters:

query - the non-null query to perform against custom index

sort - how to order the results of the query

startOffset - the zero-based offset of the first content result to return

limit - the maximum number content results to return

Since:

7.20