com.atlassian.confluence.search.service
Class DefaultPredefinedSearchBuilder

java.lang.Object
  extended by com.atlassian.confluence.search.service.DefaultPredefinedSearchBuilder
All Implemented Interfaces:
PredefinedSearchBuilder

public class DefaultPredefinedSearchBuilder
extends Object
implements PredefinedSearchBuilder


Constructor Summary
DefaultPredefinedSearchBuilder()
           
 
Method Summary
 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)
          Deprecated. See super class javadoc.
 Search usersSearch(String query, int maxResults)
          Deprecated. See super class javadoc.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultPredefinedSearchBuilder

public DefaultPredefinedSearchBuilder()
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 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.

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.

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. See super class javadoc.

Specified by:
siteSearch in interface PredefinedSearchBuilder

usersSearch

@Deprecated
public Search usersSearch(String query,
                                     int maxResults)
Deprecated. See super class javadoc.

Specified by:
usersSearch in interface PredefinedSearchBuilder


Copyright © 2003-2013 Atlassian. All Rights Reserved.