public class

PreferenceValidationForStrings

extends PreferenceDefinitionImpl

java.lang.Object
↳	com.microstrategy.web.preferences.PreferenceDefinitionBase
	↳	com.microstrategy.web.preferences.PreferenceDefinitionImpl
		↳	com.microstrategy.web.preferences.PreferenceValidationForStrings

Class Overview

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

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

Protected Methods
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

abstract void	buildXmlAttributes(XMLBuilder builder) This is used to persist the state of the preference definition.
boolean	clusterPropagate() Whether changes to the preference will also propagate to other Intelligence Servers in the cluster.
List<PreferenceAllowableValue>	getAllowableValues() Retrieves a list of `PreferenceAllowableValue` objects which are supported by thie preference.
String	getDescription() A description of the definition.
PreferenceLevels	getEnumPreferenceLevels()
String	getName() The name/key of the definition.
PreferenceLevel	getScope() The scope refers to the PreferenceLevel which this definition applies.
String	getType()
String	getValue() The value of the definition.
abstract void	setAttributes(Attributes attrs, PreferenceLevels group, boolean update) This restores the state of the preference definition from a set of XML attributes.
abstract void	setAttributes(Attributes attrs, PreferenceLevels group) This restores the state of the preference definition from a set of XML attributes.
void	setClusterPropagate(boolean propagate) Configures whether changes to the preference will also propagate to other Intelligence Servers in the cluster.
void	setDescription(String value) Update the description of a definition.
void	setEnumPreferenceLevels(PreferenceLevels lvls)
void	setName(String name)
void	setScope(PreferenceLevel lvl) Updates the scope of the definition.
void	setType(String type) Type is an application dependent declaration - typically used for validating the value property.
void	setValue(String value) Update the value of the definition.
String	toString()
abstract void	validate(String value, Preferences pref, Object validationObject) This method is triggered by callback when setting preference values.

From class java.lang.Object

From interface com.microstrategy.web.preferences.PreferenceDefinition

abstract boolean	clusterPropagate() Whether changes to the preference will also propagate to other Intelligence Servers in the cluster.
abstract List<PreferenceAllowableValue>	getAllowableValues() Retrieves a list of `PreferenceAllowableValue` objects which are supported by thie preference.
abstract String	getDescription() A description of the definition.
abstract String	getName() The name/key of the definition.
abstract PreferenceLevel	getScope() The scope refers to the PreferenceLevel which this definition applies.
abstract String	getType()
abstract String	getValue() The value of the definition.
abstract void	setClusterPropagate(boolean propagate) Configures whether changes to the preference will also propagate to other Intelligence Servers in the cluster.
abstract void	setDescription(String val) Update the description of a definition.
abstract void	setScope(PreferenceLevel lvl) Updates the scope of the definition.
abstract void	setType(String type) Type is an application dependent declaration - typically used for validating the value property.
abstract void	setValue(String val) Update the value of the definition.

Public Constructors

public PreferenceValidationForStrings ()

Protected Methods

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

Interfaces

Classes

Exceptions

PreferenceValidationForStrings

Class Overview

Summary

Public Constructors

public PreferenceValidationForStrings ()

Protected Methods

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

Returns

Throws