Package com.microstrategy.web.app.taglibs

Class QuickSearchTagHelper

    • Constructor Detail

      • QuickSearchTagHelper

        public QuickSearchTagHelper()

    • Method Detail

      • cleanState

        public void cleanState()
        Resets the state of the tag library, by cleaning the values of the properties initialized for this tag.
        Overrides:
        cleanState in class MstrPageTagHelper
        Since:
        MicroStrategy Web 9.0.0

      • getContent

        public MarkupOutput getContent()
                        throws java.io.IOException
        Obtains the contents to render based on the attributes that have been defined (if existing).
        Specified by:
        getContent in class AbstractNoBodyTagHelper
        Returns:
        a MarkupOutput instance initialized with the contents to display
        Throws:
        java.io.IOException - if an error happens while getting the contents to render.

      • setObjectTypes

        public void setObjectTypes​(java.lang.String value)
        Sets the list of object-types used for searching. This must be a comma separated list of object-types. Valid object types are those from the EnumDSSXMLObjectSubTypes or EnumDSSXMLObjectTypes enumerations.
        Since:
        MicroStrategy Web 9.0.0

      • getObjectTypes

        protected java.lang.String getObjectTypes()
        Returns a comma separated list of object-types. If this parameter is not explicitly set, this method will return the default list of object types, that is: reports, documents and folders.
        Since:
        MicroStrategy Web 9.0.0

      • setRootFolderId

        public void setRootFolderId​(java.lang.String value)
        Sets the id of the folder to be used as root for searching. This must be a valid id of a folder existing in the md.
        Since:
        MicroStrategy Web 9.0.0

      • getRootFolderId

        protected java.lang.String getRootFolderId()
        Returns the id of the folder to be used as root for searching. If this parameter has not been explicitly set, it will be calculated based on the application context.
        Since:
        MicroStrategy Web 9.0.0

      • getSysFolder

        protected int getSysFolder()
        Returns the system folder name as defined in EnumDSSXMLFolderNames to be used as root for searching. When a folder-id is also set, this method will return "0". If shared-reports has been set, this method might return "0" if the admin has configured a custom folder for shared reports.
        If this parameter has not been explicitly set, it will be calculated based on the application context.
        Since:
        MicroStrategy Web 9.0.0

      • setSysFolder

        public void setSysFolder​(java.lang.String sysFolder)
        Sets the system folder name as defined in EnumDSSXMLFolderNames to be used as root for searching. When a non-system folder should be used, this value must be set to "0". Assigning any other value will clear the root folder id parameter.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        getSysFolder()

      • getPreferenceSharedReportsFolderID

        protected java.lang.String getPreferenceSharedReportsFolderID()
        Returns the value of the admin preference for shared reports, or null if it has not been set.
        Since:
        MicroStrategy Web 9.0.0