com.atlassian.confluence.search.service

Class DefaultPredefinedSearchBuilder

java.lang.Object

com.atlassian.confluence.search.service.DefaultPredefinedSearchBuilder

All Implemented Interfaces:

PredefinedSearchBuilder

public class DefaultPredefinedSearchBuilder
extends Object
implements PredefinedSearchBuilder

Constructor Summary

Constructors

Constructor and Description
DefaultPredefinedSearchBuilder() Deprecated. Since 5.9 use DefaultPredefinedSearchBuilder(SpaceManager)
DefaultPredefinedSearchBuilder(SpaceManager spaceManager)

Method Summary

Modifier and Type	Method and Description
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 ISearch used to find users know to the system based on parts of their name or user name.
ISearch	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.
Search	siteSearch(SearchQueryParameters searchQueryParams, int startIndex, int pageSize) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPredefinedSearchBuilder

public DefaultPredefinedSearchBuilder(SpaceManager spaceManager)

DefaultPredefinedSearchBuilder

@Deprecated
public DefaultPredefinedSearchBuilder()

Deprecated. Since 5.9 use DefaultPredefinedSearchBuilder(SpaceManager)

Method Detail

buildSiteSearch

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

Description copied from interface: PredefinedSearchBuilder

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

Specified by:

buildSiteSearch in interface PredefinedSearchBuilder

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.

buildUsersSearch

public ISearch buildUsersSearch(String query,
                                int maxResults)

Description copied from interface: PredefinedSearchBuilder

Create and return the ISearch 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.

Specified by:

buildUsersSearch in interface PredefinedSearchBuilder

Parameters:

query - the query term

maxResults - the maximum number of results to return

Returns:

the user search for Confluence.

buildUsersSearch

public ISearch buildUsersSearch(UserSearchQueryParameters userSearchQueryParameters,
                                int startIndex,
                                int numberOfResults)

Description copied from interface: PredefinedSearchBuilder

Create and return the ISearch 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.

Specified by:

buildUsersSearch in interface PredefinedSearchBuilder

Parameters:

userSearchQueryParameters - the parameters, including the query term

startIndex - the offset in the overall results to start returning results from

numberOfResults - the maximum number of results to return

Returns:

the user search for Confluence.

buildRecentUpdateSearch

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

Description copied from interface: PredefinedSearchBuilder

Create a recent update search.

Specified by:

buildRecentUpdateSearch in interface PredefinedSearchBuilder

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

siteSearch

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

Deprecated.

Specified by:

siteSearch in interface PredefinedSearchBuilder