Package com.microstrategy.web.app

Class BrowserSettingDefinition

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.app.BrowserSettingDefinition

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class BrowserSettingDefinition
extends AbstractConfigurationElement

Defines a single cookie used by the application and the default value to use if the setting for the cookie is missing.

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATT_DESC
static java.lang.String	ATT_NAME
static java.lang.String	ATT_VALUE
static java.lang.String	NODE_BROWSER_SETTING_DEFINITION	Tag name identifier for this framework object

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
BrowserSettingDefinition()	Class Constructor.
BrowserSettingDefinition(java.lang.String name, java.lang.String value)	Constructor for an BrowserSettingDefinition with the given the arguments.
BrowserSettingDefinition(org.w3c.dom.Node root)	Creates an BrowserSettingDefinition with the information in the xml node.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Get the description of the browser setting here represented
protected java.lang.String	getKeyAttribute()	This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
java.lang.String	getName()	Get the name of the browser setting here represented
java.lang.String	getValue()	Get the (default) value of the browser setting represented by this instance.
void	setDescription(java.lang.String description)	Set the description for the browser setting
void	setName(java.lang.String name)	Sets the name of the browser setting here represented
void	setValue(java.lang.String value)	Set the (default) value of the browser setting.

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ATT_NAME

public static final java.lang.String ATT_NAME

See Also:

Constant Field Values

ATT_DESC

public static final java.lang.String ATT_DESC

See Also:

Constant Field Values

ATT_VALUE

public static final java.lang.String ATT_VALUE

See Also:

Constant Field Values

NODE_BROWSER_SETTING_DEFINITION

public static final java.lang.String NODE_BROWSER_SETTING_DEFINITION

Tag name identifier for this framework object

See Also:

Constant Field Values

Constructor Detail

BrowserSettingDefinition

public BrowserSettingDefinition()

Class Constructor. Creates an empty instance.

BrowserSettingDefinition

public BrowserSettingDefinition(org.w3c.dom.Node root)

Creates an BrowserSettingDefinition with the information in the xml node.

Parameters:

root - An XML Node with the information for this event map.

BrowserSettingDefinition

public BrowserSettingDefinition(java.lang.String name,
                                java.lang.String value)

Constructor for an BrowserSettingDefinition with the given the arguments.

Parameters:

name - the name of the browsersetting

value - the value of the browsersetting

Method Detail

getKeyAttribute

protected java.lang.String getKeyAttribute()

Description copied from class: AbstractConfigurationElement

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

Specified by:

getKeyAttribute in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0

getName

public java.lang.String getName()

Get the name of the browser setting here represented

Returns:

the name of the browser setting

setName

public void setName(java.lang.String name)

Sets the name of the browser setting here represented

Parameters:

name - The new name of the browser setting

Since:

MicroStrategy Web 9.0.0

getDescription

public java.lang.String getDescription()

Get the description of the browser setting here represented

Returns:

the description of the browser setting

setDescription

public void setDescription(java.lang.String description)

Set the description for the browser setting

Parameters:

description - The description for the browser setting

Since:

MicroStrategy Web 9.0.0

getValue

public java.lang.String getValue()

Get the (default) value of the browser setting represented by this instance. This value is used if the setting is missing, such as the first time that the cookie is used or after cookies have been deleted.

Returns:

the default value of the browser setting

setValue

public void setValue(java.lang.String value)

Set the (default) value of the browser setting. This value is used if the setting is missing, such as the first time that the cookie is used or after cookies have been deleted.

Since:

MicroStrategy Web 9.0.0