public interface

WebTemplateMetricSubtotal

com.microstrategy.web.objects.WebTemplateMetricSubtotal

This interface is deprecated.
This interface is now deprecated. Subtotals are defined at the template level now. Please use WebTemplateSubtotal instead.

Class Overview

The WebTemplateMetricSubtotal interface represents the settings for a subtotal of a single type within the WebTemplateMetricSubtotals collection. This interface allows the user to gather information about and turn on/off the subtotal.

Summary

Public Methods
abstract void addAxisSubtotal(int axisIndex, int subTotalStyle)
Adds the subtotal to the given axis using the given style.
abstract int getAxisSubtotal(int axisIndex)
Returns the subtotal style setting for the given axis in the report.
abstract WebMetric getDefinition()
Returns the definition of a custom subtotal.
abstract int getKey()
Returns the key of the subtotal within the WebTemplateMetricSubtotals collection.
abstract int getType()
Returns the type of subtotal.
abstract SimpleList getUnits()
Returns a SimpleList which contains the single units on the report which this subtotal is set on.
abstract boolean isActive()
Returns whether the subtotal is active.
abstract void removeAxisSubtotal(int axisIndex)
Turns off the subtotal on the given axis.

Public Methods

public abstract void addAxisSubtotal (int axisIndex, int subTotalStyle)

Adds the subtotal to the given axis using the given style.

Parameters
axisIndex The axis to add the subtotal to, from EnumDSSXMLAxisName.
subTotalStyle The style to apply to the given axis, from EnumDSSXMLSubtotalStyle.
Throws
IllegalArgumentException Thrown if the axis given is not valid.
UnsupportedOperationException Thrown if the collection is read-only.

public abstract int getAxisSubtotal (int axisIndex)

Returns the subtotal style setting for the given axis in the report. This value, from EnumDSSXMLSubtotalStyle, will tell the setting of the subtotal on the given axis.

Parameters
axisIndex The index of the axis to check, from EnumDSSXMLAxisName.
Returns
Throws
IllegalArgumentException Thrown if the given axisIndex is invalid.

public abstract WebMetric getDefinition ()

Returns the definition of a custom subtotal. A custom subtotal is a subtotal whose type is EnumDSSXMLMetricType.DssXmlMetricSubtotal.

Returns
  • The metric which the custom subtotal refers to. This will be an object of type WebMetric.
Throws
UnsupportedOperationException Thrown if the subtotal is not a custom subtotal, that is, its subtotal type is not EnumDSSXMLMetricType.DssXmlMetricSubtotal.

public abstract int getKey ()

Returns the key of the subtotal within the WebTemplateMetricSubtotals collection. The key is a unique value assigned to each item in the collection.

Returns
  • The key of the subtotal object.

public abstract int getType ()

Returns the type of subtotal.

Returns

public abstract SimpleList getUnits ()

Returns a SimpleList which contains the single units on the report which this subtotal is set on. This list can be used to add/remove the subtotal from single units on the report.

Returns
  • A SimpleList which can be used to add/remove this subtotal from units on the report.

public abstract boolean isActive ()

Returns whether the subtotal is active. A subtotal is active if it is turned on for any of the three axes or any unit on the report.

Returns
  • Whether the subtotal is active.

public abstract void removeAxisSubtotal (int axisIndex)

Turns off the subtotal on the given axis.

Parameters
axisIndex The axis to remove the subtotal from. This should come from EnumDSSXMLAxisName.
Throws
IllegalArgumentException Thrown if the axis given is not valid.
UnsupportedOperationException Thrown if the collection is read-only.