MicroStrategy ONE

MonitorSort

The MonitorSort interface represents a list of the sort criteria that are used to sort the results of a data retrieval call on the MonitorSource. It is a collection of MonitorSortCondition objects, where a condition is made up of a field, an operator, and one or more values.

The order of the collection is significant. The earlier sort conditions are applied first.

The MonitorSort interface has the following methods:

  • add():MonitorSortCondition 

    Adds a sort condition to the collection. This method takes a field value— from the enumerations EnumDSSXMLJobInfo, EnumDSSXMLDBConnectionInfo, or EnumDSSXMLUserConnectionInfo— and a value that specifies whether the sort order is ascending or descending— from the enumeration EnumDSSXMLOrder. This method returns a MonitorSortCondition object, which represents the newly added sort condition.  

  • get():MonitorSortCondition

    Returns the sort condition in the collection at the given 0-based index. This method returns a MonitorSortCondition object, which represents the newly added sort condition.  

  • remove()

    Used to remove a single sort condition from the collection, either by index or by object.  

  • size()

    Returns the number of sort conditions in the collection.  

  • clear()

    Clears all sort conditions in the collection.