|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.profiles.ProfileField
public class ProfileField
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.
represents one of the possible options of a profile field
,
contains user data for a specific profile field
,
Serialized FormNested 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 |
---|
public ProfileField()
Method Detail |
---|
public long getID()
public void setID(long ID)
ID
- the id representing this profile field.public java.lang.String getName()
public void setName(java.lang.String name)
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- the description of this profile fieldpublic boolean isRequired()
public void setRequired(boolean required)
required
- true if this field is required, false otherwise.public boolean isFilterable()
public void setFilterable(boolean filterable)
filterable
- true if this field is filterable, false otherwise.public boolean isSearchable()
public void setSearchable(boolean searchable)
searchable
- true if this field is searchable, false otherwise.public boolean isVisible()
public void setVisible(boolean visible)
visible
- true if this field is visible by the public, false otherwise.public boolean isEditable()
public void setEditable(boolean editable)
editable
- true if this field is editable by the user, false otherwise.public int getTypeID()
ProfileField.Type
of this profile field. The Type object
can be retreived by calling getType()
.
ProfileField.Type
of this profile field.public void setTypeID(int typeID)
ProfileField.Type
of this profile field.
typeID
- the id of the ProfileField.Type
of this profile field.public ProfileField.Type getType()
ProfileField.Type
of this profile field.
ProfileField.Type
of this profile field.public java.util.List getOptions()
ProfileFieldOption
objects for this profile field.
ProfileFieldOption
objects for this profile field.public void setOptions(java.util.List options)
ProfileFieldOption
objects for this profile field.
options
- a list of ProfileFieldOption
objects for this profile field.public int getIndex()
public void setIndex(int index)
index
- the index of this profile fieldpublic boolean isDatetime()
public int getCachedSize()
getCachedSize
in interface Cacheable
public void readExternal(java.io.DataInput in) throws java.io.IOException
readExternal
in interface com.tangosol.io.ExternalizableLite
java.io.IOException
public void writeExternal(java.io.DataOutput out) throws java.io.IOException
writeExternal
in interface com.tangosol.io.ExternalizableLite
java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |