Package com.atlassian.confluence.plugins.rest.service

Interface RestSearchService

All Known Implementing Classes:

DefaultRestSearchService

public interface RestSearchService

Service to implement different search algorithms

Method Summary

Modifier and Type	Method	Description
SearchResultEntityList	fullSearch(RestSearchParameters restSearchParameters, Integer startIndex, Integer pageSize)
SearchResultEntityList	groupSearch(String query, Integer maxResults)	Find all active groups which match or begin with the supplied query.
SearchResultEntityList	nameSearch(RestSearchParameters searchParameters, boolean groupResults, int startIndex, Integer pageSize, Integer maxResultsPerGroup)
SearchResultEntityList	userSearch(String query, Integer maxResults)
SearchResultEntityList	userSearch(String query, Integer maxResults, boolean showUnlicensedUsers)

Method Detail

userSearch

SearchResultEntityList userSearch(String query,
                                  Integer maxResults)
                           throws SearchServiceException

Throws:

SearchServiceException

userSearch

SearchResultEntityList userSearch(String query,
                                  Integer maxResults,
                                  boolean showUnlicensedUsers)
                           throws SearchServiceException

Throws:

SearchServiceException

groupSearch

SearchResultEntityList groupSearch(String query,
                                   Integer maxResults)
                            throws SearchServiceException

Find all active groups which match or begin with the supplied query.

Parameters:

query -

maxResults -

Returns:

the matching groups

Throws:

SearchServiceException

fullSearch

SearchResultEntityList fullSearch(RestSearchParameters restSearchParameters,
                                  Integer startIndex,
                                  Integer pageSize)
                           throws SearchServiceException

Throws:

SearchServiceException

nameSearch

SearchResultEntityList nameSearch(RestSearchParameters searchParameters,
                                  boolean groupResults,
                                  int startIndex,
                                  Integer pageSize,
                                  Integer maxResultsPerGroup)
                           throws SearchServiceException

Throws:

SearchServiceException