Uses of Interface
com.atlassian.confluence.search.v2.ISearch

Packages that use ISearch

Package	Description
com.atlassian.confluence.internal.index.lucene
com.atlassian.confluence.internal.search
com.atlassian.confluence.internal.search.v2
com.atlassian.confluence.internal.search.v2.lucene	Provides a Lucene-backed implementation of the SearchManager.
com.atlassian.confluence.plugins.opensearch
com.atlassian.confluence.rss
com.atlassian.confluence.search.service
com.atlassian.confluence.search.v2	Provides an extensible, flexible search API.
com.atlassian.confluence.spaces.actions

Uses of ISearch in com.atlassian.confluence.internal.index.lucene

Methods in com.atlassian.confluence.internal.index.lucene with parameters of type ISearch

Modifier and Type	Method	Description
SearchResults	LuceneSearchIndexAccessor.search(ISearch search, Set<String> requestedFields)

Uses of ISearch in com.atlassian.confluence.internal.search

Classes in com.atlassian.confluence.internal.search that implement ISearch

Modifier and Type	Class	Description
protected static class	DecoratedSearchManager.DecoratedSearch

Methods in com.atlassian.confluence.internal.search with parameters of type ISearch

Modifier and Type	Method	Description
String	DecoratedSearchManager.explain(ISearch search, long contentId)
SearchResults	DecoratedSearchManager.search(ISearch search)
SearchResults	DecoratedSearchManager.search(ISearch search, Set<String> requestedFields)
<T> Map<T,List<Map<String,String>>>	DecoratedSearchManager.searchCategorised(ISearch search, SearchManager.Categorizer<T> categorizer)
List<Searchable>	DecoratedSearchManager.searchEntities(ISearch search, SearchManager.EntityVersionPolicy versionPolicy)

Uses of ISearch in com.atlassian.confluence.internal.search.v2

Methods in com.atlassian.confluence.internal.search.v2 with parameters of type ISearch

Modifier and Type	Method	Description
String	ProfiledSearchManager.explain(ISearch search, long contentId)
SearchResults	ProfiledSearchManager.search(ISearch search)
SearchResults	ProfiledSearchManager.search(ISearch search, Set<String> requestedFields)
<T> Map<T,List<Map<String,String>>>	ProfiledSearchManager.searchCategorised(ISearch search, SearchManager.Categorizer<T> categorizer)
List<Searchable>	ProfiledSearchManager.searchEntities(ISearch search, SearchManager.EntityVersionPolicy versionPolicy)

Uses of ISearch in com.atlassian.confluence.internal.search.v2.lucene

Methods in com.atlassian.confluence.internal.search.v2.lucene with parameters of type ISearch

Modifier and Type	Method	Description
String	LuceneSearchManager.explain(ISearch search, long contentId)
SearchResults	LuceneSearchManager.search(ISearch search)
SearchResults	LuceneSearchManager.search(ISearch search, Set<String> requestedFields)
<T> Map<T,List<Map<String,String>>>	LuceneSearchManager.searchCategorised(ISearch search, SearchManager.Categorizer<T> categorizer)	Perform a search with the given criteria, the top results are collected per category specified by the given SearchManager.Categorizer.
List<Searchable>	LuceneSearchManager.searchEntities(ISearch search, SearchManager.EntityVersionPolicy versionPolicy)

Uses of ISearch in com.atlassian.confluence.plugins.opensearch

Methods in com.atlassian.confluence.plugins.opensearch with parameters of type ISearch

Modifier and Type	Method	Description
SearchWithToken	SearchTokenTracker.createToken(ISearch search, @Nullable String pit)	Creates a new SearchWithToken for the provided search and PIT
SearchResults	DefaultOpenSearchSearchManager.search(ISearch search)
SearchResults	DefaultOpenSearchSearchManager.search(ISearch search, Set<String> requestedFields)
SearchResults	OpenSearchSearchIndexAccessor.search(ISearch search, Set<String> requestedFields)
<T> Map<T,List<Map<String,String>>>	DefaultOpenSearchSearchManager.searchCategorised(ISearch search, SearchManager.Categorizer<T> categorizer)
List<Searchable>	DefaultOpenSearchSearchManager.searchEntities(ISearch search, SearchManager.EntityVersionPolicy versionPolicy)

Uses of ISearch in com.atlassian.confluence.rss

Methods in com.atlassian.confluence.rss with parameters of type ISearch

Modifier and Type	Method	Description
com.rometools.rome.feed.synd.SyndFeed	DefaultFeedBuilder.createSyndFeed(ISearch search, FeedProperties feedProperties)
com.rometools.rome.feed.synd.SyndFeed	SyndFeedService.createSyndFeed(ISearch search, FeedProperties feedProperties)	Constructs a feed off the specified search.

Uses of ISearch in com.atlassian.confluence.search.service

Methods in com.atlassian.confluence.search.service that return ISearch

Modifier and Type	Method	Description
ISearch	DefaultPredefinedSearchBuilder.buildRecentUpdateSearch(RecentUpdateQueryParameters params, int startIndex, int numberOfResults)
ISearch	PredefinedSearchBuilder.buildRecentUpdateSearch(RecentUpdateQueryParameters recentUpdateQueryParameters, int startIndex, int numberOfResults)	Create a recent update search.
ISearch	DefaultPredefinedSearchBuilder.buildSiteSearch(SearchQueryParameters searchQueryParams, int startIndex, int pageSize)	If no query parameters are provided, the default site search will query all content, and filter for non-archived and permissible content.
ISearch	PredefinedSearchBuilder.buildSiteSearch(SearchQueryParameters searchQueryParams, int startIndex, int pageSize)	Create and return the Search used to perform a site wide search in Confluence.
ISearch	DefaultPredefinedSearchBuilder.buildUsersSearch(UserSearchQueryParameters userSearchQueryParameters, int startIndex, int numberOfResults)
ISearch	DefaultPredefinedSearchBuilder.buildUsersSearch(String query, int maxResults)
ISearch	PredefinedSearchBuilder.buildUsersSearch(UserSearchQueryParameters userSearchQueryParameters, int startIndex, int numberOfResults)	Create and return the ISearch used to find users know to the system based on parts of their name or user name.
ISearch	PredefinedSearchBuilder.buildUsersSearch(String query, int maxResults)	Create and return the ISearch used to find users know to the system based on parts of their name or user name.

Uses of ISearch in com.atlassian.confluence.search.v2

Classes in com.atlassian.confluence.search.v2 with type parameters of type ISearch

Modifier and Type	Class	Description
class	DecoratorSearchBuilder<SEARCH extends ISearch>	A builder for a search object that decorates another search object.
static interface	ISearch.Builder<SEARCH extends ISearch>	Builder interface to create new search instance with the specified values

Subinterfaces of ISearch in com.atlassian.confluence.search.v2

Modifier and Type	Interface	Description
interface	SearchWithToken	A search that additionally specifies a search token.

Classes in com.atlassian.confluence.search.v2 that implement ISearch

Modifier and Type	Class	Description
class	AbstractSearch	An abstract representation of a search to be performed.
class	ChangesSearch	Represents a search against change information.
class	ContentSearch	Represents a search against Confluence content.
class	DefaultSearch
class	DefaultSearchWithToken

Methods in com.atlassian.confluence.search.v2 that return ISearch

Modifier and Type	Method	Description
ISearch	ContentSearch.Builder.build()
ISearch	SearchDecorator.decorate(ISearch search)
default ISearch	ISearch.withIndices(List<Index> indices)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.0.
default ISearch	ISearch.withLimit(int limit)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.0.
default ISearch	ISearch.withQuery(SearchQuery query)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.0.

Methods in com.atlassian.confluence.search.v2 that return types with arguments of type ISearch

Modifier and Type	Method	Description
ISearch.Builder<? extends ISearch>	ISearch.toBuilder()

Methods in com.atlassian.confluence.search.v2 with parameters of type ISearch

Modifier and Type	Method	Description
SELF	AbstractSearch.AbstractBuilder.copyFrom(ISearch search)
ISearch	SearchDecorator.decorate(ISearch search)
default String	SearchManager.explain(ISearch search, long contentId)	Produce an explanation of the search query for the specified contentId.
SearchResults	DelegatingSearchIndexAccessor.search(ISearch search, Set<String> requestedFields)
SearchResults	SearchIndexAccessor.search(ISearch search, Set<String> requestedFields)	Perform a search, the returned SearchResults only have the fields requested in the projection filled out, no other fields are valid in the searchResult.
SearchResults	SearchManager.search(ISearch search)	Perform a search with a given criteria.
SearchResults	SearchManager.search(ISearch search, Set<String> requestedFields)	Perform a search with a given criteria, the returns searchResults only have the fields requested in the projection filled out, no other fields are valid in the searchResult.
default <T> Map<T,List<Map<String,String>>>	SearchManager.searchCategorised(ISearch search, SearchManager.Categorizer<T> categorizer)	Perform a search with the given criteria, the top results are collected per category specified by the given SearchManager.Categorizer.
List<Searchable>	SearchManager.searchEntities(ISearch search, SearchManager.EntityVersionPolicy versionPolicy)	Perform a search with the given criteria, returning the results as a list of database entity objects.

Constructors in com.atlassian.confluence.search.v2 with parameters of type ISearch

Modifier	Constructor	Description
	DefaultSearchWithToken(ISearch delegate, long searchToken)

Constructor parameters in com.atlassian.confluence.search.v2 with type arguments of type ISearch

Modifier	Constructor	Description
	DecoratorSearchBuilder(ISearch.Builder<?> delegate, Function<ISearch,SEARCH> mapper)

Uses of ISearch in com.atlassian.confluence.spaces.actions

Methods in com.atlassian.confluence.spaces.actions that return ISearch

Modifier and Type	Method	Description
ISearch	CreateRssFeedAction.createSearchQuery()