Interface StatisticSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidCompendiumSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, Suppliable
public interface StatisticSearchOrder extends OsidCompendiumSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByMeter

      void orderByMeter(SearchOrderStyle style)
      Specified a preference for ordering results by the metered object.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsMeterSearchOrder

      boolean supportsMeterSearchOrder()
      Tests if a MeterSearchOrder is available.
      Returns:
      true if a meter search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getMeterSearchOrder

      MeterSearchOrder getMeterSearchOrder()
      Gets the search order for a meter.
      Returns:
      the meter search order
      Throws:
      UnimplementedException - supportsMeterSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsMeterSearchOrder()} is {@code true} .

    • orderByMeteredObject

      void orderByMeteredObject(SearchOrderStyle style)
      Specified a preference for ordering results by the metered object.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderBySum

      void orderBySum(SearchOrderStyle style)
      Specified a preference for ordering results by the sum.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByMean

      void orderByMean(SearchOrderStyle style)
      Specified a preference for ordering results by the mean.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByMedian

      void orderByMedian(SearchOrderStyle style)
      Specified a preference for ordering results by the median.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByMode

      void orderByMode(SearchOrderStyle style)
      Specified a preference for ordering results by the mode.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByStandardDeviation

      void orderByStandardDeviation(SearchOrderStyle style)
      Specified a preference for ordering results by the standard deviation.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRMS

      void orderByRMS(SearchOrderStyle style)
      Specified a preference for ordering results by the root mean square.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByDelta

      void orderByDelta(SearchOrderStyle style)
      Specified a preference for ordering results by the delta.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByPercentChange

      void orderByPercentChange(SearchOrderStyle style)
      Specified a preference for ordering results by the percent change.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByAverageRate

      void orderByAverageRate(SearchOrderStyle style)
      Specified a preference for ordering results by the average rate.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getStatisticSearchOrderRecord

      StatisticSearchOrderRecord getStatisticSearchOrderRecord(Type statisticRecordType) throws OperationFailedException
      Gets the meter search order record corresponding to the given statistic record Type . Multiple retrievals return the same underlying object.
      Parameters:
      statisticRecordType - a statistic record type
      Returns:
      the statistic search order record
      Throws:
      NullArgumentException - statisticRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(statisticRecordType) is false
      Compliance:
      mandatory - This method must be implemented.