WebMetricHierarchicalSortConfig (Web API 2021)

All Superinterfaces:

WebMetricSortConfig, WebSort, WebSortConfig

All Known Implementing Classes:

WebMetricHierarchicalSortConfigImpl
```
public interface WebMetricHierarchicalSortConfig
extends WebMetricSortConfig
```
This interface is intented to configure a sort operation on a grid. This interface represents a purely configuration object. That implies that its implementations would be standalone config objects (unlike WebSort which is tied to grid template objects). The getters on such implementations thus would represent the values set instead of actual values on a template.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getSubtotalID()`	Returns the subtotal ID set
`int`	`getSubtotalType()`	Returns the subtotal type set.
`void`	`setSubtotalByType(int subtotalType)`	Sets the subtotal definition for the sort by specifying its subtotal type.
`void`	`setSubtotalID(java.lang.String id)`	Sets the subtotal ID

Methods inherited from interface com.microstrategy.web.objects.WebMetricSortConfig
getMetric, setElements, setMetric

Methods inherited from interface com.microstrategy.web.objects.WebSort
getKey, getPosition, getRespectParent, getSortType, getSubtotalsPosition, getTarget, isAscending, setAscending, setRespectParent, setSubtotalsPosition

Methods inherited from interface com.microstrategy.web.objects.WebSortConfig
generateDelta, getAxis, setAxis

- Method Detail
  - setSubtotalByType
```
void setSubtotalByType(int subtotalType)
                throws java.lang.IllegalArgumentException
```
    Sets the subtotal definition for the sort by specifying its subtotal type.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - getSubtotalType
```
int getSubtotalType()
```
    Returns the subtotal type set.
  - setSubtotalID
```
void setSubtotalID(java.lang.String id)
```
    Sets the subtotal ID
    
    Parameters:
    
    id -
  - getSubtotalID
```
java.lang.String getSubtotalID()
```
    Returns the subtotal ID set