Class PreferenceAllowableValue
- java.lang.Object
-
- com.microstrategy.web.preferences.PreferenceAllowableValue
-
- All Implemented Interfaces:
java.lang.Comparable<PreferenceAllowableValue>
public class PreferenceAllowableValue extends java.lang.Object implements java.lang.Comparable<PreferenceAllowableValue>
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.- Since:
- MicroStrategy Web 9.0.0
-
-
Constructor Summary
Constructors Constructor Description PreferenceAllowableValue()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
buildXmlAttributes(XMLBuilder builder)
Constructs an XML representation of the allowable value.int
compareTo(PreferenceAllowableValue arg0)
boolean
equals(PreferenceAllowableValue arg0)
java.lang.String
getDescription()
Retrieves the description for the allowable value.java.lang.String
getDescriptionID()
Retrieves the descriptionID for the allowable value.java.lang.String
getName()
Retrieves the name of the allowable value.java.lang.String
getValue()
Retrieves the value for the allowable value object.protected void
setAttributes(org.xml.sax.Attributes attrs)
Populates the object with attributes from parsing the definition XML.protected void
setAttributes(org.xml.sax.Attributes attrs, boolean update)
Populates the object with attributes from parsing the definition XML.void
setDescription(java.lang.String value)
Sets the description for the allowable value.void
setDescriptionID(java.lang.String value)
Sets the descriptionID for the allowable value.void
setName(java.lang.String name)
Sets the name for the allowable value.void
setValue(java.lang.String value)
The value for the allowable value object.
-
-
-
Method Detail
-
setValue
public void setValue(java.lang.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.
-
getValue
public java.lang.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.
-
getName
public java.lang.String getName()
Retrieves the name of the allowable value.- Returns:
- The name of the allowable value.
- Since:
- MicroStrategy Web 9.0.1
-
setName
public void setName(java.lang.String name)
Sets the name for the allowable value.- Parameters:
name
- The name for the allowable value.- Since:
- MicroStrategy Web 9.0.1
-
getDescription
public java.lang.String getDescription()
Retrieves the description for the allowable value.- Returns:
- The description for the allowable value.
-
setDescription
public void setDescription(java.lang.String value)
Sets the description for the allowable value.- Parameters:
value
- The description for the allowable value.
-
getDescriptionID
public java.lang.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.
-
setDescriptionID
public void setDescriptionID(java.lang.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.
-
setAttributes
protected void setAttributes(org.xml.sax.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
-
setAttributes
protected void setAttributes(org.xml.sax.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- Since:
- MicroStrategy Web 9.0.1
-
buildXmlAttributes
protected void buildXmlAttributes(XMLBuilder builder)
Constructs an XML representation of the allowable value. Persists the following attributes: name, value, description, and descriptionID.- Parameters:
builder
-- See Also:
PreferenceDefinitionBase.buildXmlAttributes(XMLBuilder)
-
compareTo
public int compareTo(PreferenceAllowableValue arg0)
- Specified by:
compareTo
in interfacejava.lang.Comparable<PreferenceAllowableValue>
- Since:
- MicroStrategy Web 9.0.1
-
equals
public boolean equals(PreferenceAllowableValue arg0)
- Since:
- MicroStrategy Web 9.0.1
-
-