Package com.microstrategy.web.app.beans

Interface ObjectBrowserTabBean

    • Field Detail

      • CONTENTS_TYPE_WEBFOLDER

        static final int CONTENTS_TYPE_WEBFOLDER
        Constant that indicates the object of the contents this instance will generate is an instance of WebFolder
        See Also:
        Constant Field Values

      • CONTENTS_TYPE_RWDATAELEMENTS

        static final int CONTENTS_TYPE_RWDATAELEMENTS
        Constant that indicates the object of the contents this instance will generate is an instance of RWDataSets
        See Also:
        Constant Field Values

      • CONTENTS_TYPE_WEB_WORKING_SET

        static final int CONTENTS_TYPE_WEB_WORKING_SET
        Constant that indicates the object of the contents this instance will generate is an instance of WebWorkingSet
        See Also:
        Constant Field Values

    • Method Detail

      • getContents

        java.lang.Object getContents()
        Get an instance with the contents to be rendered on the tab
        Returns:
        an Object instance with the objects that should be rendered as part of the tab information for the Object Browser. For determining the type of instance this object is, the getContentsType() method can be called.

      • getContentsType

        int getContentsType()
        This method allows users of this interface to know the type of output to expect from the getContents() method, since for example, in some cases, it might be a WebFolder instance (when returning searches, folder browsing or report working set information) or a RWDataSets instance (when returning data element information from a report writing bean)
        Returns:
        an int value indicating the type of instance the getContents() method will return. For example it will return CONTENTS_TYPE_WEBFOLDER when the output is a WebFolder instance, or CONTENTS_TYPE_RWDATAELEMENTS when it is a RWDataSets instance.

      • setObjectFilter

        void setObjectFilter​(java.lang.String objectFilter)
        Set the filter to use when obtaining the contents to display. A default object filter specification is defined, but it can be overwritten when using this method. The filter specified here will be applicable only when a search is run for retrieving the information to render to the user.
        Parameters:
        objectFilter - a String specifying the object filter to use, with the following format:
        targetMode1:objectSubtype1,objectSubtype2,objectSubtype3;targetMode2:objectSubtype2
        Where the target mode is specified on the parent ObjectBrowserManagerBean instance.
        If no target is specified, then it means that regardless of the target mode, it will use the list of object subtypes specified as filter. For example:
        objectSubtype1,objectSubtype2,objectSubtype3

      • getObjectFilter

        int[] getObjectFilter()
        Get an array of object subtypes to use for filtering when a search is run.
        Returns:
        an array of int values representing the filter to use if the target mode is the data (EnumObjectBrowserTargets.ObjectBrowserTargetReport)

      • getObjectFilter

        int[] getObjectFilter​(int targetMode)
        Get an array of object subtypes to use for filtering when a search is run.
        Parameters:
        targetMode - the target mode indicated for selecting the filter defined for it. For example, EnumObjectBrowserTargets.ObjectBrowserTargetReport
        Returns:
        an array of int values representing the filter to use corresponding to the target mode specified.

      • prepareTabContentsList

        void prepareTabContentsList()
        Prepare the list of contents this tab will get displayed to the user. These contents will later on be available to users via the getContents() method.

      • setDesignModeStage

        void setDesignModeStage​(int designModeStage)
        Holds the stage of the design mode (EnumReportDesignMode) . The report frame bean will be responsible for setting this property of the objectbrowser tab beans.
        Parameters:
        designModeStage -

      • getDesignModeStage

        int getDesignModeStage()
        Get the stage of the design mode (EnumReportDesignMode).
        Returns:
        int

      • isTargetingFilter

        boolean isTargetingFilter()
        Returns if the object browser is targeting the filter or not
        Returns:
        True if the user is editing the report filter, False otherwise