Package com.atlassian.confluence.search.service

Interface PredefinedSearchBuilder

All Known Implementing Classes:

DefaultPredefinedSearchBuilder

public interface PredefinedSearchBuilder

Class for building searches that are commonly used.

Method Summary

Modifier and Type	Method	Description
ISearch	buildRecentUpdateSearch(RecentUpdateQueryParameters recentUpdateQueryParameters, 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(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	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.

Method Detail

buildSiteSearch

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 parameters describing the search terms and filtering for the search.

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

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. 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.

Throws:

IllegalArgumentException - if there is a problem with the supplied parameters such as maxResults less than one.

buildUsersSearch

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. 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:

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.

Throws:

IllegalArgumentException - if there is a problem with the supplied parameters such as maxResults less than one.

buildRecentUpdateSearch

ISearch buildRecentUpdateSearch(RecentUpdateQueryParameters recentUpdateQueryParameters,
                                int startIndex,
                                int numberOfResults)

Create a recent update search.

Parameters:

recentUpdateQueryParameters - 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