com.jivesoftware.community.webservices
Interface ProfileSearchService

public interface ProfileSearchService

Provides the ability to search users.

Since:

2.0

Method Summary

java.util.List<WSUser>	getSimilarUserResults(long targetUserID) Returns the the first 5 users that are similar to the specified user.
boolean	isSearchEnabled() Returns true if the profile search feature is turned on.
java.util.List<WSUser>	search(WSProfileSearchQuery query) Returns the users that correspond to the search query.
java.util.List<WSUser>	searchBounded(WSProfileSearchQuery query, int startIndex, int numResults) Returns the users that correspond to the search query beginning at startIndex and until the number results equals numResults.

Method Detail

isSearchEnabled

boolean isSearchEnabled()

Returns true if the profile search feature is turned on. When profile search is disabled, other methods serve as no-ops.

Returns:

true if the search is enabled.

search

java.util.List<WSUser> search(WSProfileSearchQuery query)
                              throws CommunityNotFoundException,
                                     UnauthorizedException

Returns the users that correspond to the search query.

Parameters:

query - the profile search query

Returns:

the users that match the search criteria.

Throws:

CommunityNotFoundException - if the community in the query could no be found.

UnauthorizedException - if the user is not authorized to perform the query.

searchBounded

java.util.List<WSUser> searchBounded(WSProfileSearchQuery query,
                                     int startIndex,
                                     int numResults)
                                     throws CommunityNotFoundException,
                                            UnauthorizedException

Returns the users that correspond to the search query beginning at startIndex and until the number results equals numResults.

Parameters:

query - the profile search query

startIndex - the starting index in the search result to return.

numResults - the number of users to return in the search result.

Returns:

the users that match the search criteria.

Throws:

CommunityNotFoundException - if the community in the query could no be found.

UnauthorizedException - if the user is not authorized to perform the query.

getSimilarUserResults

java.util.List<WSUser> getSimilarUserResults(long targetUserID)

Returns the the first 5 users that are similar to the specified user. This method only checks profile data, and does not use username, name, or email address as a means of determining similarity.

Parameters:

targetUserID - the user ID that other user records will be similar to

Returns:

the 5 users that are similar to the specified user