public interface

WebMetricSort

implements WebSort
com.microstrategy.web.objects.WebMetricSort
Known Indirect Subclasses

Class Overview

This interface contains methods specific to the operations which are necessary to perform a metric sort.

Summary

Public Methods
abstract WebElements getElements()
Returns a WebElements collection which can be used to specify additional keys to be used in the sort.
abstract WebMetric getMetric()
Returns the metric which is the target of the sort.
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

Public Methods

public abstract WebElements getElements ()

Returns a WebElements collection which can be used to specify additional keys to be used in the sort. This collection will generally contain elements of units on the template other than the metrics collection. NOTE: User normally should not add a metric element into this elements collection. If a user adds a metric element when there is no metric defined in this sort object, then the element information will be used to set the metric. If a user adds a metric element when the metric has already been defined in this object, then the input element id will be validated with current metric. An exception may be thrown when validation fails. The metric element will not be added into this collection.

Returns
  • A WebElements collection, which will be used to determine additional sort keys for the metric sort.

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.

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