public class

BrowserSettingDefinition

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.app.BrowserSettingDefinition

Class Overview

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

Summary

Constants
String ATT_DESC
String ATT_NAME
String ATT_VALUE
String NODE_BROWSER_SETTING_DEFINITION Tag name identifier for this framework object
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
BrowserSettingDefinition()
Class Constructor.
BrowserSettingDefinition(Node root)
Creates an BrowserSettingDefinition with the information in the xml node.
BrowserSettingDefinition(String name, String value)
Constructor for an BrowserSettingDefinition with the given the arguments.
Public Methods
String getDescription()
Get the description of the browser setting here represented
String getName()
Get the name of the browser setting here represented
String getValue()
Get the (default) value of the browser setting represented by this instance.
void setDescription(String description)
Set the description for the browser setting
void setName(String name)
Sets the name of the browser setting here represented
void setValue(String value)
Set the (default) value of the browser setting.
Protected Methods
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.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_DESC

Constant Value: "desc"

public static final String ATT_NAME

Constant Value: "name"

public static final String ATT_VALUE

Constant Value: "value"

public static final String NODE_BROWSER_SETTING_DEFINITION

Tag name identifier for this framework object

Constant Value: "browser-setting"

Public Constructors

public BrowserSettingDefinition ()

Class Constructor. Creates an empty instance.

public BrowserSettingDefinition (Node root)

Creates an BrowserSettingDefinition with the information in the xml node.

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

public BrowserSettingDefinition (String name, String value)

Constructor for an BrowserSettingDefinition with the given the arguments.

Parameters
name the name of the browsersetting
value the value of the browsersetting

Public Methods

public String getDescription ()

Get the description of the browser setting here represented

Returns
  • the description of the browser setting

public String getName ()

Get the name of the browser setting here represented

Returns
  • the name of the browser setting

public 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

public void setDescription (String description)

Set the description for the browser setting

Parameters
description The description for the browser setting

public void setName (String name)

Sets the name of the browser setting here represented

Parameters
name The new name of the browser setting

public void setValue (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.

Protected Methods

protected 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.