Interface PreferenceDefinition
-
- All Known Implementing Classes:
EmptyNumericStringPreferenceDefinition
,PreferenceDefinitionBase
,PreferenceDefinitionImpl
,PreferenceDefinitionLocale
,PreferenceDefinitionMinMax
,PreferenceStartPageAllowableValue
,PreferenceValidationForDefaultLoginMode
,PreferenceValidationForMargins
,PreferenceValidationForPrintRowsColsPerPage
,PreferenceValidationForStartPage
,PreferenceValidationForStrings
public interface PreferenceDefinition
This encapsulates a more detailed description of a preference object in addition to its name and value.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
TYPE_BOOLEAN
static java.lang.String
TYPE_DEFAULT
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
clusterPropagate()
Whether changes to the preference will also propagate to other Intelligence Servers in the cluster.java.util.List<PreferenceAllowableValue>
getAllowableValues()
Retrieves a list ofPreferenceAllowableValue
objects which are supported by thie preference.java.lang.String
getDescription()
A description of the definition.java.lang.String
getName()
The name/key of the definition.PreferenceLevel
getScope()
The scope refers to the PreferenceLevel which this definition applies.java.lang.String
getType()
java.lang.String
getValue()
The value of the definition.void
setClusterPropagate(boolean propagate)
Configures whether changes to the preference will also propagate to other Intelligence Servers in the cluster.void
setDescription(java.lang.String val)
Update the description of a definition.void
setScope(PreferenceLevel lvl)
Updates the scope of the definition.void
setType(java.lang.String type)
Type is an application dependent declaration - typically used for validating the value property.void
setValue(java.lang.String val)
Update the value of the definition.
-
-
-
Field Detail
-
TYPE_BOOLEAN
static final java.lang.String TYPE_BOOLEAN
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
TYPE_DEFAULT
static final java.lang.String TYPE_DEFAULT
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
java.lang.String getName()
The name/key of the definition.
-
getValue
java.lang.String getValue()
The value of the definition.- Returns:
- The definition value.
-
setValue
void setValue(java.lang.String val)
Update the value of the definition.- Parameters:
val
- the new definition value.
-
getDescription
java.lang.String getDescription()
A description of the definition.- Returns:
- The definition description.
-
setDescription
void setDescription(java.lang.String val)
Update the description of a definition.- Parameters:
val
- The new definition description.
-
getScope
PreferenceLevel getScope()
The scope refers to the PreferenceLevel which this definition applies.- Returns:
- The definition
PreferenceLevel
scope.
-
setScope
void setScope(PreferenceLevel lvl)
Updates the scope of the definition.- Parameters:
lvl
- The newPreferenceLevel
scope.
-
setType
void setType(java.lang.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.
-
getType
java.lang.String getType()
- Returns:
- String type of the definition.
-
setClusterPropagate
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.- Since:
- MicroStrategy Web 8.0.1
-
clusterPropagate
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.
- Since:
- MicroStrategy Web 8.0.1
-
getAllowableValues
java.util.List<PreferenceAllowableValue> getAllowableValues()
Retrieves a list ofPreferenceAllowableValue
objects which are supported by thie preference.- Returns:
- A list of allowable value objects supoprted by this preference.
- Since:
- MicroStrategy Web 9.0.0
-
-