public static class

ParameterInfo.Description

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.platform.ParameterInfo.Description

Summary

Constants
String NODE_NAME
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
ParameterInfo.Description()
Public Methods
String getValue()
void setValue(String value)
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.
boolean useNodeValue()
Controls whether this element will use the node value as a property.
[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 NODE_NAME

Constant Value: "description"

Public Constructors

public ParameterInfo.Description ()

Public Methods

public String getValue ()

public void setValue (String value)

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.

protected boolean useNodeValue ()

Controls whether this element will use the node value as a property. For example, nodes defined as:


  <a att="1">This is the node value</a>
 
can expose a property which will return the node's value (This is the node vale). When this is the case, though, the element can't have any sub elements. They're mutually exclusive.

Returns
  • false by default. Override this method if you want to associate the node value with some property.