Interface WebMetricSort

  • All Superinterfaces:
    All Known Subinterfaces:

    public interface WebMetricSort
    extends WebSort
    This interface contains methods specific to the operations which are necessary to perform a metric sort.
    MicroStrategy Web 7.3.1 or earlier
    • Method Detail

      • setMetric

        void setMetric​(WebMetric metric)
                throws java.lang.IllegalArgumentException
        This method is used to set the metric which is the target of the sort.
        metric - The metric object which will be the target of the sort.
        java.lang.IllegalArgumentException - Thrown if the parameter is null or the given metric does not exist on the template.
        See Also:
      • getElements

        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.
        A WebElements collection, which will be used to determine additional sort keys for the metric sort.