java.lang.Object
- com.microstrategy.utils.config.AbstractConfigurationElement
- - com.microstrategy.web.app.FolderLink

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable
```
public class FolderLink
extends AbstractConfigurationElement
```
The FolderLink element defines a shortcut to a folder (in the metadata) that is used by a folder browser or editor associated with the context. The folder is associated either by id (the object-id for the folder from the metadata) or by sys-folder-id (a value from the EnumDSSXMLFolderNames enumeration which lists all the system folders of a metadata).

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`	`ATT_DESC`
`static java.lang.String`	`ATT_DESC_ID`
`static java.lang.String`	`ATT_FEATURE_ID`
`static java.lang.String`	`ATT_ID`
`static java.lang.String`	`ATT_IS_ROOT`
`static java.lang.String`	`ATT_SYS_FOLDER_ID`
`static java.lang.String`	`NODE_FOLDER_LINK`

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

FolderLink()

FolderLink(org.w3c.dom.Node root)
Creates a FolderLink and populates it with the information in the Xml Node.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`java.lang.String`	`getDesc()`	Returns a descriptor that the application should use to display the folder link, or shortcut, if the desc-id attribute is missing.
`java.lang.String`	`getDescId()`	Returns the Resource Bundle item id that the application should use to display the folder link, or shortcut, in the language of the user's locale.
`java.lang.String`	`getFeatureId()`	Returns the feature-id of a feature that is evaluated to determine whether the folder link, or shortcut, should be displayed.
`java.lang.String`	`getId()`	Indicates the object-id of the folder (from the metadata) that is associated with this folder-link.
`java.lang.Object`	`getKey()`	Default implementation for `getKey()`.
`protected java.lang.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.
`java.lang.String`	`getPreferredSysFolderID(AppContext appContext)`
`static java.lang.String`	`getPreferredSysFolderID(AppContext appContext, int sysFolderID)`
`int`	`getSysFolderID()`	Returns the integer id for the system folder (from the metadata) to which a folder browser or editor should be pointed when the folder link, or shortcut, is selected.
`WebObjectInfo`	`getWebFolderObject(AppContext appContext)`
`WebObjectInfo`	`getWebFolderObject(WebObjectSource wos, Messages messages)`	Deprecated. Use `getWebFolderObject(AppContext)` instead
`protected boolean`	`isKeyAttribute(java.lang.String name)`	Returns `true` is the name is that of the key attribute.
`boolean`	`isRoot()`	Returns whether this FolderLink should be used as the root folder when browsing in the given context.
`void`	`setDesc(java.lang.String desc)`	Sets a descriptor that the application should use to display the folder link, or shortcut, if the desc-id attribute is missing.
`void`	`setDescId(java.lang.String descId)`	Sets the Resource Bundle item id that the application should use to display the folder link, or shortcut, in the language of the user's locale.
`void`	`setFeatureId(java.lang.String feature)`	Sets the feature-id of a feature that is evaluated to determine whether the folder link, or shortcut, should be displayed.
`void`	`setId(java.lang.String value)`	Sets the object-id for the folder (from the metadata) to which a folder browser or editor should be pointed when the folder link, or shortcut, is selected.
`void`	`setIsRoot(boolean isRoot)`	indicates whether the FolderLink should be used as the root folder when browsing in the given context.
`void`	`setKey(org.w3c.dom.Element element)`	Default implementation for `setKey()`.
`void`	`setSysFolderID(int value)`	Sets the integer id for the system folder (from the metadata) to which a folder browser or editor should be pointed when the folder link, or shortcut, is selected.

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, 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, 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, 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

- Field Detail
  - NODE_FOLDER_LINK
```
public static final java.lang.String NODE_FOLDER_LINK
```
    See Also:
    
    Constant Field Values
  - ATT_ID
```
public static final java.lang.String ATT_ID
```
    See Also:
    
    Constant Field Values
  - ATT_SYS_FOLDER_ID
```
public static final java.lang.String ATT_SYS_FOLDER_ID
```
    See Also:
    
    Constant Field Values
  - ATT_DESC
```
public static final java.lang.String ATT_DESC
```
    See Also:
    
    Constant Field Values
  - ATT_DESC_ID
```
public static final java.lang.String ATT_DESC_ID
```
    See Also:
    
    Constant Field Values
  - ATT_IS_ROOT
```
public static final java.lang.String ATT_IS_ROOT
```
    See Also:
    
    Constant Field Values
  - ATT_FEATURE_ID
```
public static final java.lang.String ATT_FEATURE_ID
```
    Since:
    
    MicroStrategy Web 8.0.1
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FolderLink
```
public FolderLink()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - FolderLink
```
public FolderLink(org.w3c.dom.Node root)
```
    Creates a FolderLink and populates it with the information in the Xml Node. Internally it calls AbstractConfigurationElement.initFromXML(org.w3c.dom.Node).
    
    Parameters:
    
    root - the xml node.
- Method Detail
  - getId
```
public java.lang.String getId()
```
    Indicates the object-id of the folder (from the metadata) that is associated with this folder-link.
  - setId
```
public void setId(java.lang.String value)
```
    Sets the object-id for the folder (from the metadata) to which a folder browser or editor should be pointed when the folder link, or shortcut, is selected.
    
    Parameters:
    
    value - The new id for the folderlink
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getSysFolderID
```
public int getSysFolderID()
```
    Returns the integer id for the system folder (from the metadata) to which a folder browser or editor should be pointed when the folder link, or shortcut, is selected. The valid values of this attribute are defined in the EnumDSSXMLFolderNames interface. (For example, the name 'DssXmlFolderNameAutoStyles' specifies the 'AutoStyles' folder in the 'Public Objects' folder and has an integer value of '57'.) The value of this attribute does not change between product versions.
  - setSysFolderID
```
public void setSysFolderID(int value)
```
    Sets the integer id for the system folder (from the metadata) to which a folder browser or editor should be pointed when the folder link, or shortcut, is selected. The valid values of this attribute are defined in the EnumDSSXMLFolderNames interface. (For example, the name 'DssXmlFolderNameAutoStyles' specifies the 'AutoStyles' folder in the 'Public Objects' folder and has an integer value of '57'.) The value of this attribute does not change between product versions.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getDesc
```
public java.lang.String getDesc()
```
    Returns a descriptor that the application should use to display the folder link, or shortcut, if the desc-id attribute is missing.
  - setDesc
```
public void setDesc(java.lang.String desc)
```
    Sets a descriptor that the application should use to display the folder link, or shortcut, if the desc-id attribute is missing.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getDescId
```
public java.lang.String getDescId()
```
    Returns the Resource Bundle item id that the application should use to display the folder link, or shortcut, in the language of the user's locale.
  - setDescId
```
public void setDescId(java.lang.String descId)
```
    Sets the Resource Bundle item id that the application should use to display the folder link, or shortcut, in the language of the user's locale.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - isRoot
```
public boolean isRoot()
```
    Returns whether this FolderLink should be used as the root folder when browsing in the given context.
  - setIsRoot
```
public void setIsRoot(boolean isRoot)
```
    indicates whether the FolderLink should be used as the root folder when browsing in the given context.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getFeatureId
```
public java.lang.String getFeatureId()
```
    Returns the feature-id of a feature that is evaluated to determine whether the folder link, or shortcut, should be displayed. It returns null if no feature is required (i.e. it should always be displayed).
    
    Since:
    
    MicroStrategy Web 8.0.1
  - setFeatureId
```
public void setFeatureId(java.lang.String feature)
```
    Sets the feature-id of a feature that is evaluated to determine whether the folder link, or shortcut, should be displayed.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getWebFolderObject
```
public WebObjectInfo getWebFolderObject(AppContext appContext)
```
    Parameters:
    
    appContext - BeanContext initialized instance
    
    Returns:
    
    a reference to the WebObjectInfo of the folderLink object
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getPreferredSysFolderID
```
public java.lang.String getPreferredSysFolderID(AppContext appContext)
                                         throws WebObjectsException
```
    Throws:
    
    WebObjectsException
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getPreferredSysFolderID
```
public static java.lang.String getPreferredSysFolderID(AppContext appContext,
                                                       int sysFolderID)
                                                throws WebObjectsException
```
    Throws:
    
    WebObjectsException
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getWebFolderObject
```
@Deprecated
public WebObjectInfo getWebFolderObject(WebObjectSource wos,
                                        Messages messages)
```
    Deprecated.
    Use getWebFolderObject(AppContext) instead
    
    Parameters:
    
    wos - WebObjectSource initialized instance
    
    messages - Messages initialized instance
    
    Returns:
    
    a reference to the WebObjectInfo of the folderLink object
  - getKeyAttribute
```
protected java.lang.String getKeyAttribute()
```
    Description copied from class: AbstractConfigurationElement
    
    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.
    
    Specified by:
    
    getKeyAttribute in class AbstractConfigurationElement
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getKey
```
public java.lang.Object getKey()
```
    Description copied from class: AbstractConfigurationElement
    
    Default implementation for getKey(). It assumes a single attribute can be used to uniquely identify this element among its siblings; the attribute to use is specified by the getKeyAttribute() method.
    
    Specified by:
    
    getKey in interface ConfigurationElement
    
    Overrides:
    
    getKey in class AbstractConfigurationElement
    
    Returns:
    
    If getKeyAttribute() is empty returns null, otherwise it returns the value of the given attribute.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - setKey
```
public void setKey(org.w3c.dom.Element element)
```
    Description copied from class: AbstractConfigurationElement
    
    Default implementation for setKey(). It assumes a single attribute can be used to uniquely identify this element among its siblings and adds this attribute to the given element; the attribute to use is specified by the getKeyAttribute() method.
    
    Overrides:
    
    setKey in class AbstractConfigurationElement
    
    Since:
    
    MicroStrategy Web 9.0.0
  - isKeyAttribute
```
protected boolean isKeyAttribute(java.lang.String name)
```
    Description copied from class: AbstractConfigurationElement
    
    Returns true is the name is that of the key attribute.
    
    Overrides:
    
    isKeyAttribute in class AbstractConfigurationElement
    
    Since:
    
    MicroStrategy Web 9.0.0

Constructor	Description
`FolderLink()`
`FolderLink(org.w3c.dom.Node root)`	Creates a FolderLink and populates it with the information in the Xml Node.

Class FolderLink

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

NODE_FOLDER_LINK

ATT_ID

ATT_SYS_FOLDER_ID

ATT_DESC

ATT_DESC_ID

ATT_IS_ROOT

ATT_FEATURE_ID

Constructor Detail

FolderLink

FolderLink

Method Detail

getId

setId

getSysFolderID

setSysFolderID

getDesc

setDesc

getDescId

setDescId

isRoot

setIsRoot

getFeatureId

setFeatureId

getWebFolderObject

getPreferredSysFolderID

getPreferredSysFolderID

getWebFolderObject

getKeyAttribute

getKey

setKey

isKeyAttribute