Package com.microstrategy.web.app
Class ObjBrowserFolderLinks
- java.lang.Object
-
- com.microstrategy.utils.config.AbstractConfigurationElement
-
- com.microstrategy.utils.config.AbstractConfigurationElementList
-
- com.microstrategy.web.app.ObjBrowserFolderLinks
-
- All Implemented Interfaces:
ConfigurationElement
,ConfigurationElementList
,ConfigurationFile
,java.lang.Cloneable
public class ObjBrowserFolderLinks extends AbstractConfigurationElementList
Lists a series of folder link definitions. Each folder-link element represents a shortcut to a system folder. These shortcuts are rendered in several folder browsers within the application, such as the Report All Object Browser and the browsers associated with the Save As Dialog and the Object Manipulation Dialog.- Since:
- MicroStrategy Web 8.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_CONTEXT_LIST
Constant for the name of the 'context-list' node in the objBrowserFolderLinks.xml-
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 ObjBrowserFolderLinks()
Class constructor.ObjBrowserFolderLinks(org.w3c.dom.Document doc)
Class constructor.ObjBrowserFolderLinks(org.w3c.dom.Node root)
Class constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static java.util.List
getFlattenedContextFolderList(int contextId, AppContext appContext, java.lang.String projectID, WebComponent wc, StringWrapper selectedPath)
Method to get a list of tree node representing ancestor folders given the object browser context (EnumObjectBrowserContexts
), a project ID, and the {WebFolder
starting folder is retrieved from XML configuration.static java.util.List
getFlattenedContextFolderList(WebFolder startFolder, int contextId, AppContext appContext, java.lang.String projectID, WebComponent wc, StringWrapper selectedPath)
Method to get a list of tree node representing ancestor folders given the object browser context (EnumObjectBrowserContexts
), a project ID, and the {WebFolder
starting folder.static java.util.List
getFlattenedCustomFolderList(java.lang.String rootFolderId, int contextId, AppContext appContext, java.lang.String projectID, WebComponent wc, StringWrapper selectedPath)
SimpleList
getFolderLinks(int contextID, java.lang.String projectID)
Method that returns a list of FolderLinks for a particular context and project.SimpleList
getFolderLinks(AppContext appContext, int contextID, java.lang.String projectID)
Deprecated.Use the method that takes a WebComponent instead of AppContext for correct feature resolution.SimpleList
getFolderLinks(WebComponent component, int contextID, java.lang.String projectID)
Method that returns a list of FolderLinks for a particular context and project.java.util.ArrayList
getFolderObjects(int contextId, java.lang.String projectId, AppContext appContext, WebComponent bean)
Returns a list containing the object browser folder links available for the current context.FolderLink
getRootFolder(int contextID, java.lang.String projectID)
Method to get the root folder as aFolderLink
given the object browser context (EnumObjectBrowserContexts
) and a project ID-
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_CONTEXT_LIST
public static final java.lang.String NODE_CONTEXT_LIST
Constant for the name of the 'context-list' node in the objBrowserFolderLinks.xml- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ObjBrowserFolderLinks
public ObjBrowserFolderLinks()
Class constructor. Initializes a new -empty- instance of the ErrorInfoList class.
-
ObjBrowserFolderLinks
public ObjBrowserFolderLinks(org.w3c.dom.Node root)
Class constructor. Initializes a ObjBrowserFolderLinksList instance based on the information included in the XML Node- Parameters:
root
- Node instance representing the shortcut list information.
-
ObjBrowserFolderLinks
public ObjBrowserFolderLinks(org.w3c.dom.Document doc)
Class constructor. Initializes a ObjBrowserFolderLinksList instance based on the information included in the DOM Document- Parameters:
doc
- Document instance representing the shortcut list information.
-
-
Method Detail
-
getFolderLinks
public SimpleList getFolderLinks(int contextID, java.lang.String projectID)
Method that returns a list of FolderLinks for a particular context and project.- Parameters:
contextID
- intprojectID
- String- Returns:
- SimpleList
-
getFolderLinks
public SimpleList getFolderLinks(AppContext appContext, int contextID, java.lang.String projectID)
Deprecated.Use the method that takes a WebComponent instead of AppContext for correct feature resolution.Method that returns a list of FolderLinks for a particular context and project.- Parameters:
appContext
- AppContextcontextID
- intprojectID
- String- Returns:
- SimpleList
- Since:
- MicroStrategy Web 8.0.1
-
getFolderLinks
public SimpleList getFolderLinks(WebComponent component, int contextID, java.lang.String projectID)
Method that returns a list of FolderLinks for a particular context and project.- Parameters:
component
- The component to use for feature checks.contextID
- intprojectID
- String- Returns:
- SimpleList
- Since:
- MicroStrategy Web 9.0.0
-
getFolderObjects
public java.util.ArrayList getFolderObjects(int contextId, java.lang.String projectId, AppContext appContext, WebComponent bean)
Returns a list containing the object browser folder links available for the current context.- Returns:
- SimpleList
- Since:
- MicroStrategy Web 9.0.0
-
getRootFolder
public FolderLink getRootFolder(int contextID, java.lang.String projectID)
Method to get the root folder as aFolderLink
given the object browser context (EnumObjectBrowserContexts
) and a project ID- Parameters:
contextID
-projectID
-- Returns:
- the root folder as a
FolderLink
-
getFlattenedCustomFolderList
public static java.util.List getFlattenedCustomFolderList(java.lang.String rootFolderId, int contextId, AppContext appContext, java.lang.String projectID, WebComponent wc, StringWrapper selectedPath)
-
getFlattenedContextFolderList
public static java.util.List getFlattenedContextFolderList(WebFolder startFolder, int contextId, AppContext appContext, java.lang.String projectID, WebComponent wc, StringWrapper selectedPath)
Method to get a list of tree node representing ancestor folders given the object browser context (EnumObjectBrowserContexts
), a project ID, and the {WebFolder
starting folder. will be retrieved from what's being given.- Parameters:
startFolder
- WebFolder the folder the browsing will start offcontextID
- int id of the browser contextappContext
- the AppContext objectprojectID
- String the id of the projectwc
- WebComponentselectedPath
- StringWrapper stores a flatten out folder path from root folder up- Returns:
- list of {
MutableTreeNode
} representing ancestor folder structure
-
getFlattenedContextFolderList
public static java.util.List getFlattenedContextFolderList(int contextId, AppContext appContext, java.lang.String projectID, WebComponent wc, StringWrapper selectedPath)
Method to get a list of tree node representing ancestor folders given the object browser context (EnumObjectBrowserContexts
), a project ID, and the {WebFolder
starting folder is retrieved from XML configuration. will be retrieved from what's being given.- Parameters:
contextID
- int id of the browser contextappContext
- the AppContext objectprojectID
- String the id of the projectwc
- WebComponentselectedPath
- StringWrapper stores a flatten out folder path from root folder up- Returns:
- list of {
MutableTreeNode
} representing ancestor folder structure - Since:
- MicroStrategy Web 9.0.0
-
-