public interface

WebMetricHierarchicalSort

implements WebMetricSort
com.microstrategy.web.objects.WebMetricHierarchicalSort

Class Overview

This interface represents a metric hierarchical sort. This interface contains the methods which are relevant only for a metric hierarchical sort.

Summary

Public Methods
abstract WebTemplateMetricSubtotal getSubtotal()
This method is deprecated. Use getTemplateSubtotal() instead
abstract WebTemplateSubtotal getTemplateSubtotal()
Returns the subtotal has been defined for this hierarchical sort.
abstract void setSubtotal(WebTemplateSubtotal subtotal)
Sets a WebTemplateSubtotal to be the subtotal definition for this hierarchical sort.
abstract void setSubtotal(WebTemplateMetricSubtotal subtotal)
This method is deprecated. Use setSubtotal(WebTemplateSubtotal) instead
abstract void setSubtotalByType(int subtotalType)
Sets the subtotal definition for the sort by specifying its subtotal type.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebMetricSort
From interface com.microstrategy.web.objects.WebSort

Public Methods

public abstract WebTemplateMetricSubtotal getSubtotal ()

This method is deprecated.
Use getTemplateSubtotal() instead

Returns the subtotal has been defined for this hierarchical sort.

Returns

public abstract WebTemplateSubtotal getTemplateSubtotal ()

Returns the subtotal has been defined for this hierarchical sort.

Returns

public abstract void setSubtotal (WebTemplateSubtotal subtotal)

Sets a WebTemplateSubtotal to be the subtotal definition for this hierarchical sort.

Parameters
subtotal The WebTemplateSubtotal object to serve as the definition. This object should come from the template that this sort object is associated with.
See Also

public abstract void setSubtotal (WebTemplateMetricSubtotal subtotal)

This method is deprecated.
Use setSubtotal(WebTemplateSubtotal) instead

Sets a WebTemplateMetricSubtotal to be the subtotal definition for this hierarchical sort.

Parameters
subtotal The WebTemplateMetricSubtotal object to serve as the definition. This object should come from the template that this sort object is associated with.
See Also

public abstract void setSubtotalByType (int subtotalType)

Sets the subtotal definition for the sort by specifying its subtotal type. This method will look up the corresponding WebTemplateSubtotal object with the given type. Note that the setSubtotal method must be called to set a custom subtotal as the subject of the sort.

Parameters
subtotalType The subtotal type to search for, from EnumDSSXMLMetricType.
Throws
IllegalArgumentException Thrown if the subtotalType is not a valid value, if the subtotal type given is DssXmlMetricSubtotal, or if the given subtotal is not currently set on the associated metric.