WebMetricSortConfig (Web API 2021)

All Superinterfaces:

WebSort, WebSortConfig

All Known Subinterfaces:

WebMetricHierarchicalSortConfig

All Known Implementing Classes:

WebMetricHierarchicalSortConfigImpl
```
public interface WebMetricSortConfig
extends WebSortConfig
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`WebMetric`	`getMetric()`	Returns the metric which is the target of the sort.
`void`	`setElements(java.lang.String... elementIDs)`
`void`	`setMetric(WebMetric metric)`	This method is used to set the metric which is the target of the sort.

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
  - getMetric
```
WebMetric getMetric()
```
    Returns the metric which is the target of the sort.
    
    Returns:
    
    The metric which is the target of the sort, or null if it has not been set.
    
    See Also:
    
    setMetric(com.microstrategy.web.objects.WebMetric)
  - setMetric
```
void setMetric(WebMetric metric)
        throws java.lang.IllegalArgumentException
```
    This method is used to set the metric which is the target of the sort.
    
    Parameters:
    
    metric - The metric object which will be the target of the sort.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if the parameter is null or the given metric does not exist on the template.
    
    See Also:
    
    getMetric()
  - setElements
```
void setElements(java.lang.String... elementIDs)
```