public interface

WebMetricSortConfig

implements WebSortConfig
com.microstrategy.web.objects.WebMetricSortConfig
Known Indirect Subclasses

Summary

Public Methods
abstract WebMetric getMetric()
Returns the metric which is the target of the sort.
abstract void setElements(String... elementIDs)
abstract void setMetric(WebMetric metric)
This method is used to set the metric which is the target of the sort.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebSort
From interface com.microstrategy.web.objects.WebSortConfig

Public Methods

public abstract 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

public abstract void setElements (String... elementIDs)

public abstract void setMetric (WebMetric metric)

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
IllegalArgumentException Thrown if the parameter is null or the given metric does not exist on the template.
See Also