com.jivesoftware.community.webservices
Class ProfileField

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

public class ProfileField
extends java.lang.Object

A profile field defines a single field of a user's profile, such as 'Phone Number' or 'Job Title'. It does not contain any user data related to the field. A profile field can be a variety of types (textfield, select list, etc) and collectively create a user's profile.

See Also:

represents one of the possible options of a profile field

Constructor Summary

ProfileField()

Method Summary

java.lang.String	getDescription() Gets the description of this profile field.
long	getID() Gets the id representing this profile field.
int	getIndex() Gets the index of this profile field.
java.lang.String	getName() Gets the internal name of this profile field.
ProfileFieldOption[]	getOptions() Gets a array of ProfileFieldOption objects for this profile field.
int	getTypeID() Gets the id of the type of this profile field.
boolean	isEditable() Gets whether or not this profile field is editable by the user.
boolean	isFilterable() Gets whether or not this profile field is filterable.
boolean	isRequired() Gets whether or not this profile field is a required field.
boolean	isSearchable() Gets whether or not this profile field is searchable.
boolean	isVisible() Gets whether or not this profile field is visible by the public.
void	setDescription(java.lang.String description) Sets the description of this profile field.
void	setEditable(boolean editable) Sets whether or not this profile field is editable by the user.
void	setFilterable(boolean filterable) Sets whether or not this profile field is filterable.
void	setID(long ID) Sets the id representing this profile field.
void	setIndex(int index) Sets the index of this profile field.
void	setName(java.lang.String name)
void	setOptions(ProfileFieldOption[] options) Sets a array of ProfileFieldOption objects for this profile field.
void	setRequired(boolean required) Sets whether or not this profile field is a required field.
void	setSearchable(boolean searchable) Sets whether or not this profile field is searchable.
void	setTypeID(int typeID) Sets the id of the type of this profile field.
void	setVisible(boolean visible) Sets whether or not this profile field is visible by the public.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileField

public ProfileField()

Method Detail

getID

public long getID()

Gets the id representing this profile field.

Returns:

the id representing this profile field.

setID

public void setID(long ID)

Sets the id representing this profile field.

Parameters:

ID - the id representing this profile field.

getName

public java.lang.String getName()

Gets the internal name of this profile field. The internal name is unique and generally used for internal actions.

Returns:

the display name of this profile field

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

Gets the description of this profile field.

Returns:

the description of this profile field

setDescription

public void setDescription(java.lang.String description)

Sets the description of this profile field.

Parameters:

description - the description of this profile field

isRequired

public boolean isRequired()

Gets whether or not this profile field is a required field.

Returns:

true if this field is required, false otherwise.

setRequired

public void setRequired(boolean required)

Sets whether or not this profile field is a required field.

Parameters:

required - true if this field is required, false otherwise.

isFilterable

public boolean isFilterable()

Gets whether or not this profile field is filterable.

Returns:

true if this field is filterable, false otherwise.

setFilterable

public void setFilterable(boolean filterable)

Sets whether or not this profile field is filterable.

Parameters:

filterable - true if this field is filterable, false otherwise.

isSearchable

public boolean isSearchable()

Gets whether or not this profile field is searchable.

Returns:

true if this field is searchable, false otherwise.

setSearchable

public void setSearchable(boolean searchable)

Sets whether or not this profile field is searchable.

Parameters:

searchable - true if this field is searchable, false otherwise.

isVisible

public boolean isVisible()

Gets whether or not this profile field is visible by the public.

Returns:

true if this field is visible by the public, false otherwise.

setVisible

public void setVisible(boolean visible)

Sets whether or not this profile field is visible by the public.

Parameters:

visible - true if this field is visible by the public, false otherwise.

isEditable

public boolean isEditable()

Gets whether or not this profile field is editable by the user.

Returns:

true if this field is editable by the user, false otherwise.

setEditable

public void setEditable(boolean editable)

Sets whether or not this profile field is editable by the user.

Parameters:

editable - true if this field is editable by the user, false otherwise.

getTypeID

public int getTypeID()

Gets the id of the type of this profile field.

Returns:

the id of the type of this profile field.

setTypeID

public void setTypeID(int typeID)

Sets the id of the type of this profile field.

Parameters:

typeID - the id of the type of this profile field.

getOptions

public ProfileFieldOption[] getOptions()

Gets a array of ProfileFieldOption objects for this profile field.

Returns:

a array of ProfileFieldOption objects for this profile field.

setOptions

public void setOptions(ProfileFieldOption[] options)

Sets a array of ProfileFieldOption objects for this profile field.

Parameters:

options - a array of ProfileFieldOption objects for this profile field.

getIndex

public int getIndex()

Gets the index of this profile field. The index specifies the order in which the profile fields will be displayed.

Returns:

the index of this profile field

setIndex

public void setIndex(int index)

Sets the index of this profile field. The index specifies the order in which the profile fields will be displayed.

Parameters:

index - the index of this profile field