public class

PreferenceAllowableValue

extends Object
implements Comparable<T>
java.lang.Object
   ↳ com.microstrategy.web.preferences.PreferenceAllowableValue

Class Overview

This class stores the properties for an allowable value for a preference. Each preference can have a list of allowable values which is a collection of this class.

Summary

Public Constructors
PreferenceAllowableValue()
Public Methods
int compareTo(PreferenceAllowableValue arg0)
boolean equals(PreferenceAllowableValue arg0)
String getDescription()
Retrieves the description for the allowable value.
String getDescriptionID()
Retrieves the descriptionID for the allowable value.
String getName()
Retrieves the name of the allowable value.
String getValue()
Retrieves the value for the allowable value object.
void setDescription(String value)
Sets the description for the allowable value.
void setDescriptionID(String value)
Sets the descriptionID for the allowable value.
void setName(String name)
Sets the name for the allowable value.
void setValue(String value)
The value for the allowable value object.
Protected Methods
void buildXmlAttributes(XMLBuilder builder)
Constructs an XML representation of the allowable value.
void setAttributes(Attributes attrs)
Populates the object with attributes from parsing the definition XML.
void setAttributes(Attributes attrs, boolean update)
Populates the object with attributes from parsing the definition XML.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.Comparable

Public Constructors

public PreferenceAllowableValue ()

Public Methods

public int compareTo (PreferenceAllowableValue arg0)

public boolean equals (PreferenceAllowableValue arg0)

public String getDescription ()

Retrieves the description for the allowable value.

Returns
  • The description for the allowable value.

public String getDescriptionID ()

Retrieves the descriptionID for the allowable value. It could be one of the MicroStrategy descriptor IDs of the format mstrWeb.xxx

Returns
  • The descriptionID for the allowable value.

public String getName ()

Retrieves the name of the allowable value.

Returns
  • The name of the allowable value.

public String getValue ()

Retrieves the value for the allowable value object. It will retrieve the resolved value if it is specified as a static final String field from any fully qualified class name.

Returns
  • The value for the allowable value object.

public void setDescription (String value)

Sets the description for the allowable value.

Parameters
value The description for the allowable value.

public void setDescriptionID (String value)

Sets the descriptionID for the allowable value. It could be one of the MicroStrategy descriptor IDs of the format mstrWeb.xxx

Parameters
value The descriptionID for the allowable value.

public void setName (String name)

Sets the name for the allowable value.

Parameters
name The name for the allowable value.

public void setValue (String value)

The value for the allowable value object. This can be a string constant or a static final String field from any fully qualified class name.

Parameters
value The value for the allowable value object.

Protected Methods

protected void buildXmlAttributes (XMLBuilder builder)

Constructs an XML representation of the allowable value. Persists the following attributes: name, value, description, and descriptionID.

See Also

protected void setAttributes (Attributes attrs)

Populates the object with attributes from parsing the definition XML. This method will call the setAttributes method with update value set to false. The attributes populated are as follows: Value, Name, Descrtiption and DescriptionID.

Parameters
attrs properties of the allowable value in XML form. properties or creating a new one

protected void setAttributes (Attributes attrs, boolean update)

Populates the object with attributes from parsing the definition XML. The attributes populated are as follows: Value, Name, Descrtiption and DescriptionID.

Parameters
attrs properties of the allowable value in XML form.
update the boolean flag mentioning that if it is updating existing properties or creating a new one