com.jivesoftware.community
Interface DocumentFieldOption

All Superinterfaces:

JiveObject

public interface DocumentFieldOption
extends JiveObject

Container object for document field options.

See Also:

MultiOptionDocumentField.getOptions()

Method Summary

long	getID() Returns the ID of the document field option.
int	getIndex() Returns the index of the option in the list of options for the document field.
String	getValue() Returns the value of the option.
boolean	isDefault() Returns true if this option is a default option
void	setDefault(boolean flag) Set whether or not this option is a default option
void	setValue(String value) Sets the value of the option.

Methods inherited from interface com.jivesoftware.community.JiveObject

getObjectType

Method Detail

getID

long getID()

Returns the ID of the document field option.

Specified by:

getID in interface JiveObject

Returns:

the ID of the document field option.

getIndex

int getIndex()

Returns the index of the option in the list of options for the document field.

Returns:

the index of the option in the list of options for the document field.

getValue

String getValue()

Returns the value of the option.

Returns:

the value of the option.

setValue

void setValue(String value)

Sets the value of the option.

Parameters:

value - the value of the option.

isDefault

boolean isDefault()

Returns true if this option is a default option

Returns:

true if this option is a default option

setDefault

void setDefault(boolean flag)

Set whether or not this option is a default option

Parameters:

flag - true if this is a default option