Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.profiles
Class ProfileField

java.lang.Object
  extended by com.jivesoftware.profiles.ProfileField
All Implemented Interfaces:
Cacheable, com.tangosol.io.ExternalizableLite, java.io.Serializable

public class ProfileField
extends java.lang.Object
implements Cacheable, com.tangosol.io.ExternalizableLite

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, contains user data for a specific profile field, Serialized Form

Nested Class Summary
static class ProfileField.Type
          A typesafe enum class for ProfileField types.
 
Constructor Summary
ProfileField()
           
 
Method Summary
 boolean equals(java.lang.Object object)
           
 int getCachedSize()
          Returns the esitmated cache size of this obejct by calculating the size of each field.
 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.
 java.util.List getOptions()
          Gets a list of ProfileFieldOption objects for this profile field.
 ProfileField.Type getType()
          Returns the ProfileField.Type of this profile field.
 int getTypeID()
          Gets the id of the ProfileField.Type of this profile field.
 int hashCode()
           
 boolean isDatetime()
          Indicates whether this profile field is of type DATETIME
 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 readExternal(java.io.DataInput in)
           
 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(java.util.List options)
          Sets a list 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 ProfileField.Type of this profile field.
 void setVisible(boolean visible)
          Sets whether or not this profile field is visible by the public.
 java.lang.String toString()
          Returns a String representation of the ProfileField object using the field name.
 void writeExternal(java.io.DataOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, 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 ProfileField.Type of this profile field. The Type object can be retreived by calling getType().

Returns:
the id of the ProfileField.Type of this profile field.

setTypeID

public void setTypeID(int typeID)
Sets the id of the ProfileField.Type of this profile field.

Parameters:
typeID - the id of the ProfileField.Type of this profile field.

getType

public ProfileField.Type getType()
Returns the ProfileField.Type of this profile field.

Returns:
the ProfileField.Type of this profile field.

getOptions

public java.util.List getOptions()
Gets a list of ProfileFieldOption objects for this profile field.

Returns:
a list of ProfileFieldOption objects for this profile field.

setOptions

public void setOptions(java.util.List options)
Sets a list of ProfileFieldOption objects for this profile field.

Parameters:
options - a list 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

isDatetime

public boolean isDatetime()
Indicates whether this profile field is of type DATETIME

Returns:
true if this field is of type DATETIME

getCachedSize

public int getCachedSize()
Returns the esitmated cache size of this obejct by calculating the size of each field.

Specified by:
getCachedSize in interface Cacheable
Returns:
the esitmated cache size of this obejct by calculating the size of each field.

readExternal

public void readExternal(java.io.DataInput in)
                  throws java.io.IOException
Specified by:
readExternal in interface com.tangosol.io.ExternalizableLite
Throws:
java.io.IOException

writeExternal

public void writeExternal(java.io.DataOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface com.tangosol.io.ExternalizableLite
Throws:
java.io.IOException

toString

public java.lang.String toString()
Returns a String representation of the ProfileField object using the field name.

Overrides:
toString in class java.lang.Object
Returns:
a String representation of the ProfileField object.

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)
Overrides:
equals in class java.lang.Object

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.