Package com.microstrategy.web.objects

Interface WebTemplateMetricSubtotal

public interface WebTemplateMetricSubtotal

Deprecated.

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

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.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

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

Method Detail

getType

int getType()

Deprecated.

Returns the type of subtotal.

Returns:

A value from EnumDSSXMLMetricType, corresponding to the subtotal type.

getDefinition

WebMetric getDefinition()
                 throws java.lang.UnsupportedOperationException

Deprecated.

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:

java.lang.UnsupportedOperationException - Thrown if the subtotal is not a custom subtotal, that is, its subtotal type is not EnumDSSXMLMetricType.DssXmlMetricSubtotal.

isActive

boolean isActive()

Deprecated.

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.

getAxisSubtotal

int getAxisSubtotal(int axisIndex)
             throws java.lang.IllegalArgumentException

Deprecated.

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:

The setting for the subtotal on the given axis, from EnumDSSXMLSubtotalStyle.

Throws:

java.lang.IllegalArgumentException - Thrown if the given axisIndex is invalid.

addAxisSubtotal

void addAxisSubtotal(int axisIndex,
                     int subTotalStyle)
              throws java.lang.IllegalArgumentException,
                     java.lang.UnsupportedOperationException

Deprecated.

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:

java.lang.IllegalArgumentException - Thrown if the axis given is not valid.

java.lang.UnsupportedOperationException - Thrown if the collection is read-only.

removeAxisSubtotal

void removeAxisSubtotal(int axisIndex)
                 throws java.lang.IllegalArgumentException,
                        java.lang.UnsupportedOperationException

Deprecated.

Turns off the subtotal on the given axis.

Parameters:

axisIndex - The axis to remove the subtotal from. This should come from EnumDSSXMLAxisName.

Throws:

java.lang.IllegalArgumentException - Thrown if the axis given is not valid.

java.lang.UnsupportedOperationException - Thrown if the collection is read-only.

getKey

int getKey()

Deprecated.

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.

getUnits

SimpleList getUnits()

Deprecated.

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.