Package com.microstrategy.web.preferences

Class PreferenceValidationForStrings

java.lang.Object

com.microstrategy.web.preferences.PreferenceDefinitionBase

com.microstrategy.web.preferences.PreferenceDefinitionImpl

com.microstrategy.web.preferences.PreferenceValidationForStrings

All Implemented Interfaces:

PreferenceDefinition

public class PreferenceValidationForStrings
extends PreferenceDefinitionImpl

Handles the validation of a String, for it not to contain invalid characters.

Since:

MicroStrategy Web 8.0.0

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
PreferenceValidationForStrings()

Method Summary

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

PreferenceValidationForStrings

public PreferenceValidationForStrings()

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