public interface

PreferenceDefinition

com.microstrategy.web.preferences.PreferenceDefinition
Known Indirect Subclasses

Class Overview

This encapsulates a more detailed description of a preference object in addition to its name and value.

Summary

Constants
String TYPE_BOOLEAN
String TYPE_DEFAULT
Public Methods
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.

Constants

public static final String TYPE_BOOLEAN

Constant Value: "boolean"

public static final String TYPE_DEFAULT

Constant Value: ""

Public Methods

public abstract boolean clusterPropagate ()

Whether changes to the preference will also propagate to other Intelligence Servers in the cluster. Defaults to true.

Returns
  • whether changes to the preference will also propagate to other Servers in the cluster.

public abstract List<PreferenceAllowableValue> getAllowableValues ()

Retrieves a list of PreferenceAllowableValue objects which are supported by thie preference.

Returns
  • A list of allowable value objects supoprted by this preference.

public abstract String getDescription ()

A description of the definition.

Returns
  • The definition description.

public abstract String getName ()

The name/key of the definition.

public abstract PreferenceLevel getScope ()

The scope refers to the PreferenceLevel which this definition applies.

Returns

public abstract String getType ()

Returns
  • String type of the definition.

public abstract String getValue ()

The value of the definition.

Returns
  • The definition value.

public abstract void setClusterPropagate (boolean propagate)

Configures whether changes to the preference will also propagate to other Intelligence Servers in the cluster.

Parameters
propagate whether to propagate preference value changes to other servers in the cluster.

public abstract void setDescription (String val)

Update the description of a definition.

Parameters
val The new definition description.

public abstract void setScope (PreferenceLevel lvl)

Updates the scope of the definition.

Parameters
lvl The new PreferenceLevel scope.

public abstract void setType (String type)

Type is an application dependent declaration - typically used for validating the value property. See specific PreferenceDefinition implementations for further details.

Parameters
type type of the definition.

public abstract void setValue (String val)

Update the value of the definition.

Parameters
val the new definition value.