Clearspace API (1.10.14) Web Services Client Javadocs

com.jivesoftware.community.webservices
Class ProfileFieldOption

java.lang.Object
  extended by com.jivesoftware.community.webservices.ProfileFieldOption

public class ProfileFieldOption
extends java.lang.Object

Represents a possible option of a ProfileField

See Also:
ProfileField

Constructor Summary
ProfileFieldOption()
           
 
Method Summary
 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 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.
 
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.

Clearspace Project Page

Copyright © 1999-2007 Jive Software.