com.jivesoftware.community.webservices
Class WSProfileSearchQuery

java.lang.Object
  com.jivesoftware.community.webservices.WSProfileSearchQuery

public class WSProfileSearchQuery
extends java.lang.Object

Contains the necessary information required to perform a user search.

Since:

2.0

Field Summary

static int	SORT_BY_INDEX_ORDER
static int	SORT_BY_RELEVANCE

Constructor Summary

WSProfileSearchQuery()

Method Summary

long	getCommunityID() Gets the community ID used for this query. -1 unless the user wants to find an expert in a specific community.
java.util.List<WSProfileSearchFilter>	getFilters() Gets a list of WSProfileSearchFilters used to filter user results for this query.
java.lang.String	getKeywords() Gets the keywords for the user search.
int	getSort() Gets the sort used for this query.
boolean	isSearchEmail() Returns true if the user's email field is to be searched, false otherwise.
boolean	isSearchName() Returns true if the user's name field is to be searched, false otherwise.
boolean	isSearchProfile() Returns true if the user's profile field values are to be searched, false otherwise.
boolean	isSearchUsername() Returns true if the user's username field is to be searched, false otherwise.
void	setCommunity(long communityID) Sets the community ID the user wants to find an expert in.
void	setFilters(java.util.List<WSProfileSearchFilter> filters) Sets a list of WSProfileSearchFilters used to filter user results for this query.
void	setKeywords(java.lang.String keywords) Sets the keywords for the user search.
void	setSearchEmail(boolean searchEmail) True if the user's email field is to be searched, false otherwise.
void	setSearchName(boolean searchName) True if the user's name field is to be searched, false otherwise.
void	setSearchProfile(boolean searchProfile) True if the user's profile field values are to be searched, false otherwise.
void	setSearchUsername(boolean searchUsername) True if the user's username field is to be searched, false otherwise.
void	setSort(int sort) Sets the Sort used for this query.

Methods inherited from class java.lang.Object

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

Field Detail

SORT_BY_RELEVANCE

public static final int SORT_BY_RELEVANCE

See Also:

Constant Field Values

SORT_BY_INDEX_ORDER

public static final int SORT_BY_INDEX_ORDER

See Also:

Constant Field Values

Constructor Detail

WSProfileSearchQuery

public WSProfileSearchQuery()

Method Detail

getKeywords

public java.lang.String getKeywords()

Gets the keywords for the user search.

Returns:

the keywords for the user search.

setKeywords

public void setKeywords(java.lang.String keywords)

Sets the keywords for the user search.

Parameters:

keywords - the keywords for the user search

getFilters

public java.util.List<WSProfileSearchFilter> getFilters()

Gets a list of WSProfileSearchFilters used to filter user results for this query.

Returns:

a list of WSProfileSearchFilters used to filter user results for this query.

setFilters

public void setFilters(java.util.List<WSProfileSearchFilter> filters)

Sets a list of WSProfileSearchFilters used to filter user results for this query.

Parameters:

filters - a list of WSProfileSearchFilters used to filter user results for this query.

getSort

public int getSort()

Gets the sort used for this query. Defaults to SORT_BY_RELEVANCE.

Returns:

sorting strategy for this query.

setSort

public void setSort(int sort)

Sets the Sort used for this query.

Parameters:

sort - sorting strategy for this query.

getCommunityID

public long getCommunityID()

Gets the community ID used for this query. -1 unless the user wants to find an expert in a specific community.

Returns:

the community ID the user wants to find an expert in.

setCommunity

public void setCommunity(long communityID)

Sets the community ID the user wants to find an expert in.

Parameters:

communityID - the community ID the user wants to find an expert in.

isSearchUsername

public boolean isSearchUsername()

Returns true if the user's username field is to be searched, false otherwise.

Returns:

true if the user's username field is to be searched, false otherwise.

setSearchUsername

public void setSearchUsername(boolean searchUsername)

True if the user's username field is to be searched, false otherwise.

Parameters:

searchUsername - true if the user's username field is to be searched, false otherwise.

isSearchName

public boolean isSearchName()

Returns true if the user's name field is to be searched, false otherwise. Note: The user's name field will not be searchable regardless of this value if com.jivesoftware.base.User#isNameVisible() is false.

Returns:

true if the user's name field is to be searched, false otherwise.

setSearchName

public void setSearchName(boolean searchName)

True if the user's name field is to be searched, false otherwise. Note: The user's name field will not be searchable regardless of this value if com.jivesoftware.base.User#isNameVisible() is false.

Parameters:

searchName - true if the user's name field is to be searched, false otherwise.

isSearchEmail

public boolean isSearchEmail()

Returns true if the user's email field is to be searched, false otherwise. Note: The user's email field will not be searchable regardless of this value if com.jivesoftware.base.User#isEmailVisible() is false.

Returns:

true if the user's email field is to be searched, false otherwise.

setSearchEmail

public void setSearchEmail(boolean searchEmail)

True if the user's email field is to be searched, false otherwise. Note: The user's email field will not be searchable regardless of this value if com.jivesoftware.base.User#isEmailVisible() is false.

Parameters:

searchEmail - true if the user's email field is to be searched, false otherwise.

isSearchProfile

public boolean isSearchProfile()

Returns true if the user's profile field values are to be searched, false otherwise. Note: The user's profile field values will not be searchable regardless of this value if com.jivesoftware.community.ProfileField#isVisible() is false.

Returns:

true if the user's profile field values are to be searched, false otherwise.

setSearchProfile

public void setSearchProfile(boolean searchProfile)

True if the user's profile field values are to be searched, false otherwise. Note: The user's profile field values will not be searchable regardless of this value if com.jivesoftware.community.ProfileField#isVisible() is false.

Parameters:

searchProfile - true if the user's profile field values are to be searched, false otherwise.