public class

ObjBrowserFolderLinks

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

Class Overview

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.

Summary

Constants
String NODE_CONTEXT_LIST Constant for the name of the 'context-list' node in the objBrowserFolderLinks.xml
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
ObjBrowserFolderLinks()
Class constructor.
ObjBrowserFolderLinks(Node root)
Class constructor.
ObjBrowserFolderLinks(Document doc)
Class constructor.
Public Methods
static List getFlattenedContextFolderList(WebFolder startFolder, int contextId, AppContext appContext, 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 List getFlattenedContextFolderList(int contextId, AppContext appContext, 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 List getFlattenedCustomFolderList(String rootFolderId, int contextId, AppContext appContext, String projectID, WebComponent wc, StringWrapper selectedPath)
SimpleList getFolderLinks(int contextID, String projectID)
Method that returns a list of FolderLinks for a particular context and project.
SimpleList getFolderLinks(AppContext appContext, int contextID, String projectID)
This method is deprecated. Use the method that takes a WebComponent instead of AppContext for correct feature resolution.
SimpleList getFolderLinks(WebComponent component, int contextID, String projectID)
Method that returns a list of FolderLinks for a particular context and project.
ArrayList getFolderObjects(int contextId, String projectId, AppContext appContext, WebComponent bean)
Returns a list containing the object browser folder links available for the current context.
FolderLink getRootFolder(int contextID, String projectID)
Method to get the root folder as a FolderLink given the object browser context (EnumObjectBrowserContexts) and a project ID
[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_CONTEXT_LIST

Constant for the name of the 'context-list' node in the objBrowserFolderLinks.xml

Constant Value: "folder-links"

Public Constructors

public ObjBrowserFolderLinks ()

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

public ObjBrowserFolderLinks (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.

public ObjBrowserFolderLinks (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.

Public Methods

public static List getFlattenedContextFolderList (WebFolder startFolder, int contextId, AppContext appContext, 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 off
appContext the AppContext object
projectID String the id of the project
wc WebComponent
selectedPath StringWrapper stores a flatten out folder path from root folder up
Returns

public static List getFlattenedContextFolderList (int contextId, AppContext appContext, 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
appContext the AppContext object
projectID String the id of the project
wc WebComponent
selectedPath StringWrapper stores a flatten out folder path from root folder up
Returns

public static List getFlattenedCustomFolderList (String rootFolderId, int contextId, AppContext appContext, String projectID, WebComponent wc, StringWrapper selectedPath)

public SimpleList getFolderLinks (int contextID, String projectID)

Method that returns a list of FolderLinks for a particular context and project.

Parameters
contextID int
projectID String
Returns
  • SimpleList

public SimpleList getFolderLinks (AppContext appContext, int contextID, String projectID)

This method is 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 AppContext
contextID int
projectID String
Returns
  • SimpleList

public SimpleList getFolderLinks (WebComponent component, int contextID, 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 int
projectID String
Returns
  • SimpleList

public ArrayList getFolderObjects (int contextId, String projectId, AppContext appContext, WebComponent bean)

Returns a list containing the object browser folder links available for the current context.

Returns
  • SimpleList

public FolderLink getRootFolder (int contextID, String projectID)

Method to get the root folder as a FolderLink given the object browser context (EnumObjectBrowserContexts) and a project ID

Returns