public interface PredefinedSearchBuilder
Modifier and Type | Method and 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(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.
since 3.0. Use
buildSiteSearch(SearchQueryParameters, int, int) instead. |
ISearch buildSiteSearch(SearchQueryParameters searchQueryParams, int startIndex, int pageSize)
Search
used to perform a site wide search in Confluence.searchQueryParams
- the query to executestartIndex
- 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.ISearch buildUsersSearch(String query, int maxResults)
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.query
- the query termmaxResults
- the maximum number of results to returnIllegalArgumentException
- if there is a problem with the supplied parameters such as maxResults less than
one.ISearch buildUsersSearch(UserSearchQueryParameters userSearchQueryParameters, int startIndex, int numberOfResults)
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.userSearchQueryParameters
- the parameters, including the query termstartIndex
- the offset in the overall results to start returning results fromnumberOfResults
- the maximum number of results to returnIllegalArgumentException
- if there is a problem with the supplied parameters such as maxResults less than
one.ISearch buildRecentUpdateSearch(RecentUpdateQueryParameters recentUpdateQueryParameters, int startIndex, int numberOfResults)
recentUpdateQueryParameters
- the paramsstartIndex
- 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@Deprecated Search siteSearch(SearchQueryParameters searchQueryParams, int startIndex, int pageSize)
buildSiteSearch(SearchQueryParameters, int, int)
instead.Copyright © 2003–2017 Atlassian. All rights reserved.