Package com.microstrategy.web.app.beans

Interface FormulaBarBean

    • Method Detail

      • getActiveElementIndex

        int getActiveElementIndex()
        Specified by:
        getActiveElementIndex in interface ViewBeanParserBean
        Returns:
        the Active element index. It's used to pre-select an item in the template elements list

      • setActiveElementIndex

        void setActiveElementIndex​(int activeElementIndex)
        Set the Active element index. It's used to pre-select an item in the template elements list
        Specified by:
        setActiveElementIndex in interface ViewBeanParserBean
        Parameters:
        activeElementIndex - the active element index

      • getActiveAlias

        java.lang.String getActiveAlias()
        return the active name. It's used to pre-fill the textbox for the Alias textbox.
        Returns:
        the active name.

      • setActiveAlias

        void setActiveAlias​(java.lang.String activeAlias)
        Set the active name. It's used to pre-fill the textbox for the Alias textbox.
        Parameters:
        activeAlias - the alias in String format

      • getDynamicAliasFlag

        boolean getDynamicAliasFlag()
        return the dynamic alias flag. It's used to pre-fill the dynamic alias checkbox.
        Returns:
        the active name.

      • setDynamicAliasFlag

        void setDynamicAliasFlag​(boolean dynamicAliasFlag)
        Set the dynamic alias flag. It's used to pre-fill the dynamic alias checkbox.
        Parameters:
        dynamicAliasFlag - the alias flag in boolean format

      • getActiveFormula

        java.lang.String getActiveFormula()
        return the active formula. It's used to pre-fill the textbox for the formula textbox.
        Returns:
        the active formula.

      • setActiveFormula

        void setActiveFormula​(java.lang.String activeFormula)
        Set the active formula. It's used to pre-fill the textbox for the Formula textbox.
        Parameters:
        activeFormula - the formula in String format

      • setAggFromBase

        void setAggFromBase​(java.lang.Boolean aggFromBase)
        Set Aggregate from Base flag.
        Parameters:
        aggFromBase - the Aggregate from Base flag

      • getAggFromBase

        java.lang.Boolean getAggFromBase()
        return Aggregate from Base flag.
        Returns:
        the Aggregate from Base flag.

      • getActiveElement

        TemplateElement getActiveElement()
        Returns the active template element.
        Returns:
        TemplateElement instance.
        Since:
        MicroStrategy Web 8.0.0

      • setErrorMessage

        void setErrorMessage​(java.lang.String errMssg)
        Specify an error description when processing FormularBar events.
        Parameters:
        errMssg - Localized error message.
        Since:
        MicroStrategy Web 8.0.0

      • getErrorMessage

        java.lang.String getErrorMessage()
        Indicates an error description when processing FormularBar events.
        Returns:
        errMssg Localized error message.
        Since:
        MicroStrategy Web 8.0.0

      • setActiveUserMetricId

        void setActiveUserMetricId​(java.lang.String activeUserMetricId)
        Set the active User Metric Id.
        It's used for indicating which User Metric was selected.
        Parameters:
        activeUserMetricId - The specific User Metric Id to set as active.
        Since:
        MicroStrategy Web 8.0.0

      • getActiveUserMetricId

        java.lang.String getActiveUserMetricId()
        Returns the active User Metric Id.
        Returns:
        String Id
        Since:
        MicroStrategy Web 8.0.0

      • allowInsertNewMetric

        boolean allowInsertNewMetric()
        Check to see if the user is allowed to insert new metric.
        Returns:
        boolean true if insertion is allowed
        Since:
        MicroStrategy Web 9.0.0

      • getTemplateElementsArray

        @Deprecated
java.lang.String[][] getTemplateElementsArray()
        Deprecated.
        the element array can be obtained using the TemplateElementsBean.getTemplateElementsList() method.
        Returns list of elements in template.
        Returns:
        String
        Since:
        MicroStrategy Web 8.0.0

      • getMetricsList

        @Deprecated
java.util.ArrayList getMetricsList()
        Deprecated.
        The metrics list can be obtained from the working set.
        Returns the list of metrics in the working set
        Returns:
        ArrayList
        Since:
        MicroStrategy Web 8.0.0

      • getDMMode

        int getDMMode()

      • setPassThrough

        void setPassThrough​(boolean value)

      • isPassThrough

        boolean isPassThrough()