public class

TemplateInfoList

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

Class Overview

The TemplateInfoList class is a collection of TemplateInfos instances that holds information about how to map events. For more information about TemplateInfoping, please check documention of the TemplateInfo class.

Summary

Constants
String NODE_TEMPLATES
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
TemplateInfoList()
Class constructor.
TemplateInfoList(Node root)
Class constructor.
TemplateInfoList(Node root, TemplateInfoList defaultList)
Class constructor.
TemplateInfoList(Document doc)
Class constructor.
Public Methods
TemplateInfo getTemplateInfo(int status)
Retrieve a TemplateInfo by its status.
Protected Methods
void removeDefaults(CustomizationInfo c)
This method is called when the use-default attribute is set false, so all previous values of attributes and children must be cleared.
void setPrototype(AbstractConfigurationElement prototype)
Sets the prototype object for this instance.
[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 NODE_TEMPLATES

Constant Value: "templates"

Public Constructors

public TemplateInfoList ()

Class constructor. Initializes a new -empty- instance of the TemplateInfoList class.

public TemplateInfoList (Node root)

Class constructor. Initializes a TemplateInfoList instance based on the information included in the XML Node

Parameters
root Node instance representing the shortcut list information.

public TemplateInfoList (Node root, TemplateInfoList defaultList)

Class constructor. Initializes a TemplateInfoList instance based on the information included in the XML Node

Parameters
root Node instance representing the shortcut list information.
defaultList a TemplateInfoList instance containing the default template list to use for the page.

public TemplateInfoList (Document doc)

Class constructor. Initializes a TemplateInfoList instance based on the information included in the DOM Document

Parameters
doc Document instance representing the shortcut list information.

Public Methods

public TemplateInfo getTemplateInfo (int status)

Retrieve a TemplateInfo by its status. This method returns the best possible TemplateInfo for the given status, for this it uses the list of default templates as well.
The TemplateInfo returned is in order:

  1. The TemplateInfo for the given status in this list
  2. The TemplateInfo for the given status in the default list
  3. The TemplateInfo for the status 0 (use for all status) in this list
  4. The TemplateInfo for the status 0 (use for all status) in the default list
If none TemplateInfo is found, then null is returned.

Parameters
status the status associated with the TemplateInfo
Returns

Protected Methods

protected void removeDefaults (CustomizationInfo c)

This method is called when the use-default attribute is set false, so all previous values of attributes and children must be cleared.

protected void setPrototype (AbstractConfigurationElement prototype)

Sets the prototype object for this instance. The attributes and elements of the prototype are copied into this instance.