Package com.microstrategy.web.app

Class PageInfoList

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.app.PageInfoList

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable

public class PageInfoList
extends AbstractConfigurationElementList

Since:

MicroStrategy Web 9.0.0

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	NODE_PAGES

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

ATT_VERSION

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
PageInfoList()
PageInfoList(org.w3c.dom.Node root)

Method Summary

Modifier and Type	Method	Description
void	addPage(java.lang.String pageName, PageInfo page)	Add a new Page instance to the Page Manager
void	deleteAllPages()	Delete all pages from this manager instance
void	deletePage(java.lang.String pageName)	Removes the requested PageInfo instance from the Manager, based on its ID.
PageInfo	getDefaultPage()	Return the Page that is assigned as default page
PageInfo	getPage(java.lang.String pageName)	Get the Page instance associated with the given pageName.
void	setDefaultPage(PageInfo defaultPage)

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

clear, clone, get, get, getFilteredList, getKey, getKeyAttribute, getList, getValues, getVersion, init, isEmpty, put, put, registerElementInList, remove, setVersion, size, sort

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

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, 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

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Field Detail

NODE_PAGES

public static final java.lang.String NODE_PAGES

See Also:

Constant Field Values

Constructor Detail

PageInfoList

public PageInfoList()

PageInfoList

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

Method Detail

getPage

public PageInfo getPage(java.lang.String pageName)

Get the Page instance associated with the given pageName.

Parameters:

pageName - the page's unique identifier.

Returns:

the PageInfo associated that corresponds to the given pageName.

addPage

public void addPage(java.lang.String pageName,
                    PageInfo page)

Add a new Page instance to the Page Manager

Parameters:

pageName - the page's unique identifier.

page - PageInfo instance to insert, associated with the given page ID.

deletePage

public void deletePage(java.lang.String pageName)

Removes the requested PageInfo instance from the Manager, based on its ID.

Parameters:

pageName - the page's unique identifier to look for.

getDefaultPage

public PageInfo getDefaultPage()

Return the Page that is assigned as default page

Returns:

a PageInfo instance assigned as default page

setDefaultPage

public void setDefaultPage(PageInfo defaultPage)

deleteAllPages

public void deleteAllPages()

Delete all pages from this manager instance