Class ContentSearch
- java.lang.Object
-
- com.atlassian.confluence.search.v2.AbstractSearch
-
- com.atlassian.confluence.search.v2.ContentSearch
-
- All Implemented Interfaces:
ISearch
public class ContentSearch extends AbstractSearch
Represents a search against Confluence content. This includes searching against the text/body of content.
-
-
Field Summary
Fields Modifier and Type Field Description static String
CONTENT_SEARCH
static String
CQL_SEARCH
static String
SITE_SEARCH
-
Fields inherited from class com.atlassian.confluence.search.v2.AbstractSearch
indexes, limit, query, sort, startOffset
-
-
Constructor Summary
Constructors Constructor Description ContentSearch(SearchQuery query, SearchSort sort)
Constructs a search against Confluence content.ContentSearch(SearchQuery query, SearchSort sort, int startOffset, int limit)
Constructs a search against Confluence content.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getSearchType()
Returns type of search e.g.-
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, isExplain
-
-
-
-
Field Detail
-
SITE_SEARCH
public static final String SITE_SEARCH
- See Also:
- Constant Field Values
-
CONTENT_SEARCH
public static final String CONTENT_SEARCH
- See Also:
- Constant Field Values
-
CQL_SEARCH
public static final String CQL_SEARCH
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ContentSearch
public ContentSearch(@NonNull SearchQuery query, SearchSort sort)
Constructs a search against Confluence content. The maximum number of results returned will be a system provided default.- Parameters:
query
- the non-null query to perform against Confluence contentsort
- how to order the results of thequery
- Since:
- 7.20
-
ContentSearch
public ContentSearch(@NonNull SearchQuery query, SearchSort sort, int startOffset, int limit)
Constructs a search against Confluence content.- Parameters:
query
- the non-null query to perform against Confluence contentsort
- how to order the results of thequery
startOffset
- the zero-based offset of the first content result to returnlimit
- the maximum number content results to return- Since:
- 7.20
-
-
Method Detail
-
getSearchType
public String getSearchType()
Description copied from interface:ISearch
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
-
-