com.jivesoftware.community.user.profile
Class ProfileSearchFilter

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

public class ProfileSearchFilter
extends Object

This class can filter user search results based on specific values for a ProfileField.

Constructor Summary

ProfileSearchFilter()

ProfileSearchFilter(long fieldID, String value)

Method Summary

long	getFieldID() Gets the ID of the ProfileField used to filter the user results.
String	getMaxValue() Gets the maximum value that will be used to filter the user results.
String	getMinValue() Gets the minimum value that will be used to filter the user results.
String	getValue() Gets the value that will be used to filter the user results.
boolean	isEmpty() Check if any values are available.
boolean	isValid(ProfileField.Type type) Perform some basic validation around field types.
void	setFieldID(long fieldID) Sets the ID of the ProfileField used to filter the user results.
void	setMaxValue(String maxValue) Sets the maximum value that will be used to filter the user results.
void	setMinValue(String minValue) Sets the minimum value that will be used to filter the user results.
void	setValue(String value) Sets the value that will be used to filter the user results.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileSearchFilter

public ProfileSearchFilter()

ProfileSearchFilter

public ProfileSearchFilter(long fieldID,
                           String value)

Method Detail

getFieldID

public long getFieldID()

Gets the ID of the ProfileField used to filter the user results.

Returns:

the ID of the ProfileField used to filter the user results.

setFieldID

public void setFieldID(long fieldID)

Sets the ID of the ProfileField used to filter the user results.

Parameters:

fieldID - the ID of the ProfileField used to filter the user results.

getValue

public String getValue()

Gets the value that will be used to filter the user results. Only user results with this exact value for this ProfileField will be returned.

Returns:

the value that will be used to filter the user results.

setValue

public void setValue(String value)

Sets the value that will be used to filter the user results. Only user results with this exact value for this ProfileField will be returned.

Parameters:

value - the value that will be used to filter the user results.

getMinValue

public String getMinValue()

Gets the minimum value that will be used to filter the user results. Only user results with a value greater than this value for this ProfileField will be returned.

Returns:

the minumum value that will be used to filter the user results.

setMinValue

public void setMinValue(String minValue)

Sets the minimum value that will be used to filter the user results. Only user results with a value greater than this value for this ProfileField will be returned.

Parameters:

minValue - the minumum value that will be used to filter the user results.

getMaxValue

public String getMaxValue()

Gets the maximum value that will be used to filter the user results. Only user results with a value less than this value for this ProfileField will be returned.

Returns:

the maximum value that will be used to filter the user results.

setMaxValue

public void setMaxValue(String maxValue)

Sets the maximum value that will be used to filter the user results. Only user results with a value less than this value for this ProfileField will be returned.

Parameters:

maxValue - the maximum value that will be used to filter the user results.

isEmpty

public boolean isEmpty()

Check if any values are available.

Returns:

isValid

public boolean isValid(ProfileField.Type type)

Perform some basic validation around field types.

Parameters:

type -

Returns: