public interface

SearchManager

com.atlassian.confluence.search.v2.SearchManager
Known Indirect Subclasses

Class Overview

Facade for the v2 search API.

Summary

Nested Classes
enum SearchManager.EntityVersionPolicy Determines how search results will be converted into entities by convertToEntities(SearchResults, EntityVersionPolicy) and searchEntities(ISearch, EntityVersionPolicy). 
Public Methods
List<Searchable> convertToEntities(SearchResults searchResults, SearchManager.EntityVersionPolicy versionPolicy)
Helper method to convert search results into a list of database entities.
List<Searchable> convertToEntities(SearchResults searchResults, boolean stripNull)
This method is deprecated. since 4.0. Use convertToEntities(SearchResults, EntityVersionPolicy) instead.
@Deprecated SearchResults search(Search search)
This method is deprecated. since 3.0. Use search(ISearch) by passing in a ContentSearch.
SearchResults search(ISearch search)
Perform a search with a given criteria.
SearchResults 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.
List<Searchable> searchEntities(ISearch search, SearchManager.EntityVersionPolicy versionPolicy)
Perform a search with the given criteria, returning the results as a list of database entity objects.
@Deprecated List<Searchable> searchEntities(ISearch search)
This method is deprecated. since 4.0 use searchEntities(ISearch, EntityVersionPolicy) instead.
@Deprecated List<Searchable> searchEntities(Search search)
This method is deprecated. since 3.0. Use searchEntities(ISearch, EntityVersionPolicy) instead.

Public Methods

public List<Searchable> convertToEntities (SearchResults searchResults, SearchManager.EntityVersionPolicy versionPolicy)

Helper method to convert search results into a list of database entities. Because the search index does not update at the same time as the database, a search may contain references to entities that have since been modified or deleted from the db.

Entries that have been deleted from the database are removed from the returned list of entities, so the index of the entities in the returned list may not match the indexes of the search result it corresponds to.

The behaviour for entries that have been modified in the database varies based on the versionPolicy argument. If it is set to INDEXED_VERSION, which is the recommended default, the returned entities will be the same version as found in the index. If it is set to LATEST_VERSION, the latest version of the content will be returned. Using the latest version is not recommended because it can mean permissions added to the document when it was most recently updated may not be respected.
Parameters
searchResults the results of a search from this manager
versionPolicy whether to retrieve the indexed version of content found via search (recommended), or the latest version of content (not recommended)
Returns
  • the entities represented by that search result. List may be empty if the search returned no results, or may contain null values where the result does not map to a valid database record.

public List<Searchable> convertToEntities (SearchResults searchResults, boolean stripNull)

This method is deprecated.
since 4.0. Use convertToEntities(SearchResults, EntityVersionPolicy) instead.

@Deprecated public SearchResults search (Search search)

This method is deprecated.
since 3.0. Use search(ISearch) by passing in a ContentSearch.

Throws
InvalidSearchException
See Also

public SearchResults search (ISearch search)

Perform a search with a given criteria.

Will throw an InvalidSearchException if some error occurred converting the search object into a search that could be performed in the back-end. Usually this is a sign that some plugin that was used to create the search is no longer available.

Parameters
search the search to perform
Returns
  • the results of that search
Throws
IllegalArgumentException if the search contains an invalid SearchQuery
InvalidSearchException when this manager is unable to translate and conduct the specified search. Clients should just discard the search if this occurs.

public SearchResults 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. SearchResults will throw an FieldNotRequestedException if an attempt is made to access a field value that has not had it's key included in the projection Set.

Will throw an InvalidSearchException if some error occurred converting the search object into a search that could be performed in the back-end. Usually this is a sign that some plugin that was used to create the search is no longer available.

Throws
InvalidSearchException

public List<Searchable> searchEntities (ISearch search, SearchManager.EntityVersionPolicy versionPolicy)

Perform a search with the given criteria, returning the results as a list of database entity objects. Unlike the convertToEntities(SearchResults, EntityVersionPolicy) method, the list of entities returned will not contain any nulls: search results that do not match a database record will be silently discarded.

The versionPolicy determines whether the entities returned should be the same version as stored in the index (INDEXED_VERSION) or the latest version of the same content (LATEST_VERSION). If you don't have a particular need to retrieve the latest version, it is recommended that you retrieve the indexed version so that any permission changes made to the document when updating it will be respected.
Parameters
search the search to perform
versionPolicy whether to retrieve the indexed version of content found via search (recommended), or the latest version of content (not recommended)
Returns
  • a list of Searchable objects representing the search results
Throws
IllegalArgumentException if the search contains an invalid SearchQuery
InvalidSearchException when this manager is unable to translate and conduct the specified search. Clients should just discard the search if this occurs.

@Deprecated public List<Searchable> searchEntities (ISearch search)

This method is deprecated.
since 4.0 use searchEntities(ISearch, EntityVersionPolicy) instead.

Throws
InvalidSearchException

@Deprecated public List<Searchable> searchEntities (Search search)

This method is deprecated.
since 3.0. Use searchEntities(ISearch, EntityVersionPolicy) instead.

Throws
InvalidSearchException