public class

ContextInfo

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

Class Overview

The ContextInfo element defines a group of folder links, or shortcuts. A context is generally associated with a single editor or folder browser in the application (specified through a setting in the editor or browser). The context can include different sets of folder links for different projects.

Summary

Constants
String ATT_DESC
String ATT_ID
String NODE_CONTEXT
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
ContextInfo()
Default no-arguments constructor.
ContextInfo(Node root)
Creates a ContextInfo and populates it with the information in the Xml Node.
Public Methods
ProjectInfo getDefaultProject()
String getDescription()
Returns a description of the context.
int getID()
Returns the unique identifier of the context.
Object getKey()
Default implementation for getKey().
void setDescription(String value)
Set the description of the context.
void setID(int id)
Sets the unique identifier of the context.
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.AbstractConfigurationElementList
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.ConfigurationElementList
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_DESC

Constant Value: "desc"

public static final String ATT_ID

Constant Value: "id"

public static final String NODE_CONTEXT

Constant Value: "context"

Public Constructors

public ContextInfo ()

Default no-arguments constructor.

public ContextInfo (Node root)

Creates a ContextInfo and populates it with the information in the Xml Node. Internally it calls initFromXML(Node).

Public Methods

public ProjectInfo getDefaultProject ()

public String getDescription ()

Returns a description of the context.

public int getID ()

Returns the unique identifier of the context.

public Object getKey ()

Default implementation for getKey(). It assumes a single attribute can be used to uniquely identify this element among its siblings; the attribute to use is specified by the getKeyAttribute() method.

Returns
  • If getKeyAttribute() is empty returns null, otherwise it returns the value of the given attribute.

public void setDescription (String value)

Set the description of the context.

public void setID (int id)

Sets the unique identifier of the context.

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.