public class

EmptyNumericStringPreferenceDefinition

extends PreferenceDefinitionImpl
java.lang.Object
   ↳ com.microstrategy.web.preferences.PreferenceDefinitionBase
     ↳ com.microstrategy.web.preferences.PreferenceDefinitionImpl
       ↳ com.microstrategy.web.preferences.EmptyNumericStringPreferenceDefinition

Class Overview

This class checks the string to validate as a possible preference value it's either an empty string or if it has a value, it is a valid integer with the limits specified...

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.preferences.PreferenceDefinitionImpl
From interface com.microstrategy.web.preferences.PreferenceDefinition
[Expand]
Inherited Fields
From class com.microstrategy.web.preferences.PreferenceDefinitionBase
Public Constructors
EmptyNumericStringPreferenceDefinition(String name, PreferenceLevels lvls)
EmptyNumericStringPreferenceDefinition()
Constructor for creating PreferenceDefinition objects from XML parsing.
Protected Methods
void buildXmlAttributes(XMLBuilder builder)
Constructs an XML representation of the preference definition.
void setAttributes(Attributes attrs, PreferenceLevels group, boolean update)
Populates the object with attributes from parsing the definition XML.
String validateTransmute(String value, Preferences pref, Object validationObject)
This method is triggered by callback when setting preference values.
[Expand]
Inherited Methods
From class com.microstrategy.web.preferences.PreferenceDefinitionImpl
From class com.microstrategy.web.preferences.PreferenceDefinitionBase
From class java.lang.Object
From interface com.microstrategy.web.preferences.PreferenceDefinition

Public Constructors

public EmptyNumericStringPreferenceDefinition (String name, PreferenceLevels lvls)

Throws
MSTRUncheckedException

public EmptyNumericStringPreferenceDefinition ()

Constructor for creating PreferenceDefinition objects from XML parsing.

Protected Methods

protected void buildXmlAttributes (XMLBuilder builder)

Constructs an XML representation of the preference definition. Persists the following attributes: name, value, description, type, scope, and the implementation class of PreferenceDefinition (omitted if PreferenceDefinitionImpl).

protected void setAttributes (Attributes attrs, PreferenceLevels group, boolean update)

Populates the object with attributes from parsing the definition XML.

Parameters
attrs properties of the definition in XML form.
group used to check the scope of the definition.
Throws
PreferencesException if errors occur during the population.

protected String validateTransmute (String value, Preferences pref, Object validationObject)

This method is triggered by callback when setting preference values. By default, this method doesn't do anything.

Parameters
value value to validate.
pref the Preferences hierarchy in the validation context.
Returns
  • transmuted preference value
Throws
PreferencesException