Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.profiles
Class ProfileFieldOption

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

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

Represents a possible option of a ProfileField.

See Also:
ProfileField, Serialized Form

Constructor Summary
ProfileFieldOption()
           
 
Method Summary
 int getCachedSize()
          Returns the esitmated cache size of this obejct by calculating the size of each field.
 long getFieldID()
          Gets the id of the ProfileField in which this option belongs.
 int getIndex()
          Gets the index of this option which represents the order in which the options will appear in the list.
 java.lang.String getValue()
          Gets the value of this option.
 boolean isDefaultOption()
          Gets whether or not this option is to be selected by default.
 void readExternal(java.io.DataInput in)
           
 void setDefaultOption(boolean defaultOption)
          Sets whether or not this option is to be selected by default.
 void setFieldID(long fieldID)
          Sets the id of the ProfileField in which this option belongs.
 void setIndex(int index)
          Sets the index of this option which represents the order in which the options will appear in the list.
 void setValue(java.lang.String value)
          Sets the value of this option.
 void writeExternal(java.io.DataOutput out)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProfileFieldOption

public ProfileFieldOption()
Method Detail

getFieldID

public long getFieldID()
Gets the id of the ProfileField in which this option belongs.

Returns:
the id of the ProfileField in which this option belongs.

setFieldID

public void setFieldID(long fieldID)
Sets the id of the ProfileField in which this option belongs.

Parameters:
fieldID - the id of the ProfileField in which this option belongs.

getValue

public java.lang.String getValue()
Gets the value of this option.

Returns:
the value of this option.

setValue

public void setValue(java.lang.String value)
Sets the value of this option.

Parameters:
value - the value of this option.

getIndex

public int getIndex()
Gets the index of this option which represents the order in which the options will appear in the list.

Returns:
the index of this option.

setIndex

public void setIndex(int index)
Sets the index of this option which represents the order in which the options will appear in the list.

Parameters:
index - the index of this option.

isDefaultOption

public boolean isDefaultOption()
Gets whether or not this option is to be selected by default.

Returns:
true if this option is to be selected by default, false otherwise.

setDefaultOption

public void setDefaultOption(boolean defaultOption)
Sets whether or not this option is to be selected by default.

Parameters:
defaultOption - true if this option is to be selected by default, false otherwise.

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

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.