Class 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
    • Constructor Detail

      • FolderLink

        public FolderLink()
        Since:
        MicroStrategy Web 9.0.0
    • 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
      • 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