Interface SubtotalsEditorBean

    • Method Detail

      • isMetricTotalAvailable

        boolean isMetricTotalAvailable​(int metricType,
                                       int subtotalStyle)
        Returns true if the metric and subtotal are available for the metrics axis
        Parameters:
        metricType - the metric type (subtotal | gradtotal)
        subtotalStyle - the subtotal style (i.e. min, max, avg, sum)
        Returns:
        true if the metric and subtotal are available
      • getAvailableSubtotals

        java.util.Enumeration getAvailableSubtotals()
        Returns a collection of WebTemplateSubtotal objects that are available for the template.
        Returns:
        An Enumeration of the list of subtotals
        Since:
        MicroStrategy Web 9.0.0
      • getAllTotalsState

        int getAllTotalsState​(WebTemplateSubtotal subtotal)
        Return the state of the All Totals checkbox for the given subtotal
        Parameters:
        subtotal - WebTemplateSubtotal for which the subtotal style is requested
        Returns:
        state of the subtotal. From EnumSubtotalCheckboxState
        Since:
        MicroStrategy Web 9.0.0
      • getGrandTotalsState

        int getGrandTotalsState​(WebTemplateSubtotal subtotal)
        Return the state of the Grand Totals checkbox for the given subtotal
        Parameters:
        subtotal - WebTemplateSubtotal for which the subtotal style is requested
        Returns:
        state of the subtotal. From EnumSubtotalCheckboxState
        Since:
        MicroStrategy Web 9.0.0
      • getSubtotalUnits

        java.util.Enumeration getSubtotalUnits()
        Returns a collection of WebObjectInfo objects across whose level a subtotal can be added. This list will include attributes, hierarchies, custom groups and consolidations.
        Since:
        MicroStrategy Web 9.0.0
      • getDisplayOptions

        int getDisplayOptions​(int axis)
        Returns the position of the subtotals for the specified axis. Used in the display options tab of the editor.
        Parameters:
        axis - Index of the axis for which the position of the subtotal is required
        Returns:
        int indicating the position of the subtotals from EnumDSSXMLSubtotalsPosition.
        Since:
        MicroStrategy Web 9.0.0
      • getCurrentSubtotalIndex

        int getCurrentSubtotalIndex()
        Gets the index of the current subtotal being modified by the editor
        Since:
        MicroStrategy Web 9.0.0
      • setCurrentSubtotalIndex

        void setCurrentSubtotalIndex​(int index)
        Sets the index of the current subtotal being modified by the editor
        Parameters:
        index -
        Since:
        MicroStrategy Web 9.0.0
      • getSubtotalState

        int getSubtotalState​(WebTemplateSubtotal subtotal)
        Gets the state of the subtotal specified.
        Parameters:
        subtotal - WebTemplateSubtotal for which the subtotal style is requested
        Returns:
        value indicating the state of the subtotal. From EnumSubtotalState
        Since:
        MicroStrategy Web 9.0.0
      • getSubtotalStyleForAxis

        int getSubtotalStyleForAxis​(WebTemplateSubtotal subtotal,
                                    int axisIndex)
        Gets the subtotal style for a specified axis for the subtotal. If the subtotal is not defined 'By position' this method will return EnumDSSXMLSubtotalStyle.DssXmlSubtotalNone
        Parameters:
        subtotal - WebTemplateSubtotal for which the subtotal style is requested
        axisIndex - Index of the axis for which the style is requested
        Returns:
        value indicating the state of the subtotal. From EnumDSSXMLSubtotalStyle.
        Since:
        MicroStrategy Web 9.0.0
      • getUnitsForLevel

        SimpleList getUnitsForLevel​(WebTemplateSubtotal subtotal)
        Returns a collection of WebObjectInfo objects across whose level the subtotal is defined. Returns null if the subtotal is not active or if it is not defined Across Level.
        Parameters:
        subtotal - WebTemplateSubtotal for which the list of units is requested
        Returns:
        SimpleList collection of WebObjectInfo
        Since:
        MicroStrategy Web 9.0.0