com.jivesoftware.community.user.profile
Class ProfileSearchResults

java.lang.Object
  com.jivesoftware.community.user.profile.ProfileSearchResults

public class ProfileSearchResults
extends Object

A holder for people search results, detached from Lucene internals.

Constructor Summary

ProfileSearchResults(int resultCount, Collection<Long> userIDs, List<User> users)

Method Summary

int	getResultCount() The total number of hits returned by the query.
Collection<Long>	getUserIDs() Get a list of returned userIDs.
Collection<User>	getUsers() Get a list of returned Users.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProfileSearchResults

public ProfileSearchResults(int resultCount,
                            Collection<Long> userIDs,
                            List<User> users)

Method Detail

getResultCount

public int getResultCount()

The total number of hits returned by the query. Equal or greater than the number of userIDs or users returned if pagination options are specified in the ProfileSearchQuery (start, range).

Returns:

the total number of hits returned by the query

getUserIDs

public Collection<Long> getUserIDs()

Get a list of returned userIDs. Size will always correspond with getUsers().

Returns:

a list of returned userIDs

getUsers

public Collection<User> getUsers()

Get a list of returned Users. These will be backed with UserProfiles if specified on the ProfileSearchQuery. Size will always correspond with getUserIDs().

Returns:

a list of returned Users.