public class

PreferenceDefinitionMinMax

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

Class Overview

Handles preference checks of minimum and maximum values. The values are optional (specify just one or both), but if specified, they must be numeric and will trigger validation.

  • Type: integer, real
  • Extra attributes: mn, mx
If the user's date/number format is configured to use the client's web browser value (0000), validation of real values (mn, mx) requires the validation object set with a Locale instance (determined by the client's web browser).

Summary

Constants
String Att_Max
String Att_Min
[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
PreferenceDefinitionMinMax()
Public Methods
String getMax()
String getMin()
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

Constants

public static final String Att_Max

Constant Value: "mx"

public static final String Att_Min

Constant Value: "mn"

Public Constructors

public PreferenceDefinitionMinMax ()

Public Methods

public String getMax ()

public String getMin ()

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. The attributes populated by PreferenceDefinitionImpl are as follows: name, value, description, type, scope, and the preference levels grouping.

Parameters
attrs properties of the definition in XML form.
group used to check the scope of the definition.
Throws
PreferencesException

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. The returned value will be used to set the preference value - this facilitates preprocessing such as trimming strings, or date time reformating.

Returns
  • transmuted preference value
Throws
PreferencesException