PreferenceValidationForStartPage (Web API 2021)

java.lang.Object
- com.microstrategy.web.preferences.PreferenceDefinitionBase
- - com.microstrategy.web.preferences.PreferenceDefinitionImpl
  - - com.microstrategy.web.preferences.PreferenceValidationForStartPage

All Implemented Interfaces:: PreferenceDefinition

public class PreferenceValidationForStartPage
extends PreferenceDefinitionImpl

Field Summary
- Fields inherited from class com.microstrategy.web.preferences.PreferenceDefinitionImpl
  Att_Class, Att_ClusterPropagate, Att_DescriptionID, Att_Scope, Tag_AllowableValue, Tag_AllowableValues
- Fields inherited from class com.microstrategy.web.preferences.PreferenceDefinitionBase
  _allowableValues, _clusterPropagate, _description, _levels, _name, _scope, _type, _value
- Fields inherited from interface com.microstrategy.web.preferences.PreferenceDefinition
  TYPE_BOOLEAN, TYPE_DEFAULT

Constructor Summary

Constructors
Constructor Description

PreferenceValidationForStartPage()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.lang.String`	`validateTransmute(java.lang.String value, Preferences pref, java.lang.Object validationObject)`	This method is triggered by callback when setting preference values.

Methods inherited from class com.microstrategy.web.preferences.PreferenceDefinitionImpl
buildXmlAttributes, setAttributes, setAttributes, toString, validate, validateAllowableValues

Methods inherited from class com.microstrategy.web.preferences.PreferenceDefinitionBase
clusterPropagate, getAllowableValues, getDescription, getEnumPreferenceLevels, getName, getScope, getType, getValue, setClusterPropagate, setDescription, setEnumPreferenceLevels, setName, setScope, setType, setValue, validateDataType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PreferenceValidationForStartPage
```
public PreferenceValidationForStartPage()
```
- Method Detail
  - validateTransmute
```
protected java.lang.String validateTransmute(java.lang.String value,
                                             Preferences pref,
                                             java.lang.Object validationObject)
                                      throws PreferencesException
```
    Description copied from class: PreferenceDefinitionImpl
    
    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.
    
    Overrides:
    
    validateTransmute in class PreferenceDefinitionImpl
    
    Returns:
    
    transmuted preference value
    
    Throws:
    
    PreferencesException