public class

DefaultPredefinedSearchBuilder

extends Object
implements PredefinedSearchBuilder
java.lang.Object
   ↳ com.atlassian.confluence.search.service.DefaultPredefinedSearchBuilder

Summary

Public Constructors
DefaultPredefinedSearchBuilder()
Public Methods
ISearch buildRecentUpdateSearch(RecentUpdateQueryParameters params, int startIndex, int numberOfResults)
Create a recent update search.
ISearch buildSiteSearch(SearchQueryParameters searchQueryParams, int startIndex, int pageSize)
Create and return the Search used to perform a site wide search in Confluence.
ISearch buildUsersSearch(String query, int maxResults)
Create and return the Search used to find users know to the system based on parts of their name or user name.
Search siteSearch(SearchQueryParameters searchQueryParams, int startIndex, int pageSize)
This method is deprecated. See super class javadoc.
Search usersSearch(String query, int maxResults)
This method is deprecated. See super class javadoc.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.search.service.PredefinedSearchBuilder

Public Constructors

public DefaultPredefinedSearchBuilder ()

Public Methods

public ISearch buildRecentUpdateSearch (RecentUpdateQueryParameters params, int startIndex, int numberOfResults)

Create a recent update search.

Parameters
params the params
startIndex to support paging, specify the index of the first result to be included in the result. The startIndex should be greater than 0,
numberOfResults the maximum number of results to return

public ISearch buildSiteSearch (SearchQueryParameters searchQueryParams, int startIndex, int pageSize)

Create and return the Search used to perform a site wide search in Confluence.

Parameters
searchQueryParams the query to execute
startIndex to support paging, specify the index of the first result to be included in the result. The startIndex should be greater than 0,
pageSize the maximum number of results to return. This must be greater than 0.
Returns
  • the site wide content search for Confluence.

public ISearch buildUsersSearch (String query, int maxResults)

Create and return the Search used to find users know to the system based on parts of their name or user name. You should not use wild card within the supplied query, simply supply as much as you know of the user(s) required e.g. parts of names such as "Andr" or "Peter An" or parts of usernames.

Parameters
query the query term
maxResults the maximum number of results to return
Returns
  • the user search for Confluence.

public Search siteSearch (SearchQueryParameters searchQueryParams, int startIndex, int pageSize)

This method is deprecated.
See super class javadoc.

public Search usersSearch (String query, int maxResults)

This method is deprecated.
See super class javadoc.