public interface

SubtotalsEditorBean

implements ReportFrameElement ViewBeanParserBean
com.microstrategy.web.app.beans.SubtotalsEditorBean

Class Overview

The SubtotalsEditorBean supports the Advanced Sort Editor. It uses an standard microstrategy gui editor. The user will use this editor to select the keys she wants to sort from and the sorting order.

Summary

Constants
String SUBTOTALS_AVG
String SUBTOTALS_DISABLED
String SUBTOTALS_GRAND_TOTAL
String SUBTOTALS_MAX
String SUBTOTALS_MIN
String SUBTOTALS_SUBTOTALS
String SUBTOTALS_SUM
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract int getAllTotalsState(WebTemplateSubtotal subtotal)
Return the state of the All Totals checkbox for the given subtotal
abstract Enumeration getAvailableSubtotals()
Returns a collection of WebTemplateSubtotal objects that are available for the template.
abstract int getCurrentSubtotalIndex()
Gets the index of the current subtotal being modified by the editor
abstract int getDisplayOptions(int axis)
Returns the position of the subtotals for the specified axis.
abstract int getGrandTotalsState(WebTemplateSubtotal subtotal)
Return the state of the Grand Totals checkbox for the given subtotal
abstract WebTemplateSubtotal getSubtotal(int index)
Returns a WebTemplateSubtotal object for the specified index of the subtotal.
abstract int getSubtotalState(WebTemplateSubtotal subtotal)
Gets the state of the subtotal specified.
abstract int getSubtotalStyleForAxis(WebTemplateSubtotal subtotal, int axisIndex)
Gets the subtotal style for a specified axis for the subtotal.
abstract Enumeration getSubtotalUnits()
Returns a collection of WebObjectInfo objects across whose level a subtotal can be added.
abstract SimpleList getUnitsForLevel(WebTemplateSubtotal subtotal)
Returns a collection of WebObjectInfo objects across whose level the subtotal is defined.
abstract boolean isMetricTotalAvailable(int metricType, int subtotalStyle)
abstract void setCurrentSubtotalIndex(int index)
Sets the index of the current subtotal being modified by the editor
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final String SUBTOTALS_AVG

Constant Value: "AVG"

public static final String SUBTOTALS_DISABLED

Constant Value: "OFF"

public static final String SUBTOTALS_GRAND_TOTAL

Constant Value: "GT"

public static final String SUBTOTALS_MAX

Constant Value: "MAX"

public static final String SUBTOTALS_MIN

Constant Value: "MIN"

public static final String SUBTOTALS_SUBTOTALS

Constant Value: "SUB"

public static final String SUBTOTALS_SUM

Constant Value: "SUM"

Public Methods

public abstract 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

public abstract Enumeration getAvailableSubtotals ()

Returns a collection of WebTemplateSubtotal objects that are available for the template.

Returns
  • An Enumeration of the list of subtotals

public abstract int getCurrentSubtotalIndex ()

Gets the index of the current subtotal being modified by the editor

public abstract 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

public abstract 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

public abstract WebTemplateSubtotal getSubtotal (int index)

Returns a WebTemplateSubtotal object for the specified index of the subtotal.

Parameters
index Index of the subtotal

public abstract int getSubtotalState (WebTemplateSubtotal subtotal)

Gets the state of the subtotal specified.

Parameters
subtotal WebTemplateSubtotal for which the subtotal style is requested
Returns

public abstract 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 DssXmlSubtotalNone

Parameters
subtotal WebTemplateSubtotal for which the subtotal style is requested
axisIndex Index of the axis for which the style is requested
Returns

public abstract 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.

public abstract 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

public abstract boolean isMetricTotalAvailable (int metricType, int subtotalStyle)

This method is deprecated.
Replaced by getAllTotalsState(WebTemplateSubtotal) and getGrandTotalsState(WebTemplateSubtotal)

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

public abstract void setCurrentSubtotalIndex (int index)

Sets the index of the current subtotal being modified by the editor