Package com.microstrategy.webapi

Interface EnumDSSXMLSortType

  • public interface EnumDSSXMLSortType
    Enumeration containing the options for the technique used by sort-key to collate rows of data.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DssSortByCustomOrderOnRA
      The sort discriminates on the custom order for Recursive Attribute.
      static int DssSortByCustomOrderOnRANDE
      The sort discriminates on the custom order for New Derived Element on Recursive Attribute.
      static int DssXmlSortAttributeDefault
      The sort specifies the attribute default sort to be applied.
      static int DssXmlSortAttributeForm
      The sort discriminates on the value of a form of an attribute.
      static int DssXmlSortConsolidationDefault
      The sort orders the rows so that the consolidation is put into its natural order.
      static int DssXmlSortConsolidationForm
      The sort discriminates on the value of a form of a consolidation.
      static int DssXmlSortCustomGroupDefault
      The sort orders the rows so that the custom group is put into its natural order.
      static int DssXmlSortCustomGroupForm
      The sort discriminates on the value of a form of a custom group.
      static int DssXmlSortDimensionDefault
      The sort is similar to the default attribute sort but applies to whatever attribute(s) are substituted for the given dimension.
      static int DssXmlSortDimensionForm
      The sort is similar to the attribute form sort but applies to whatever attribute(s) are substituted for the given dimension.
      static int DssXmlSortGroupByMetric
      The sort groups together all the rows that use the same metric.
      static int DssXmlSortGroupBySubtotal
      The sort groups together rows if they have the same template subtotal in their header for the given attribute.
      static int DssXmlSortMetric
      The sort discriminates by taking values from the body of the grid.
      static int DssXmlSortMetricHierarchical
      The sort is the same as DssSortMetric except that the sort pays attention to the hierarchy induced by the template.
      static int DssXmlSortSubtotalsPosition
      This sort modifies the meaning of DssSubtotalsPositionDefault for subsequent sorts in the collection.
      static int DssXmlSortValue
      The sort can only be used in an expression and it sorts the data that to which we want to apply the OLAP function so that it is in ascending/descending order.

    • Field Detail

      • DssXmlSortSubtotalsPosition

        static final int DssXmlSortSubtotalsPosition
        This sort modifies the meaning of DssSubtotalsPositionDefault for subsequent sorts in the collection.
        See Also:
        Constant Field Values

      • DssXmlSortAttributeForm

        static final int DssXmlSortAttributeForm
        The sort discriminates on the value of a form of an attribute.
        See Also:
        Constant Field Values

      • DssXmlSortAttributeDefault

        static final int DssXmlSortAttributeDefault
        The sort specifies the attribute default sort to be applied.
        See Also:
        Constant Field Values

      • DssXmlSortMetric

        static final int DssXmlSortMetric
        The sort discriminates by taking values from the body of the grid.
        See Also:
        Constant Field Values

      • DssXmlSortMetricHierarchical

        static final int DssXmlSortMetricHierarchical
        The sort is the same as DssSortMetric except that the sort pays attention to the hierarchy induced by the template.
        See Also:
        Constant Field Values

      • DssXmlSortGroupByMetric

        static final int DssXmlSortGroupByMetric
        The sort groups together all the rows that use the same metric.
        See Also:
        Constant Field Values

      • DssXmlSortGroupBySubtotal

        static final int DssXmlSortGroupBySubtotal
        The sort groups together rows if they have the same template subtotal in their header for the given attribute.
        See Also:
        Constant Field Values

      • DssXmlSortDimensionForm

        static final int DssXmlSortDimensionForm
        The sort is similar to the attribute form sort but applies to whatever attribute(s) are substituted for the given dimension.
        See Also:
        Constant Field Values

      • DssXmlSortDimensionDefault

        static final int DssXmlSortDimensionDefault
        The sort is similar to the default attribute sort but applies to whatever attribute(s) are substituted for the given dimension.
        See Also:
        Constant Field Values

      • DssXmlSortConsolidationDefault

        static final int DssXmlSortConsolidationDefault
        The sort orders the rows so that the consolidation is put into its natural order.
        See Also:
        Constant Field Values

      • DssXmlSortCustomGroupDefault

        static final int DssXmlSortCustomGroupDefault
        The sort orders the rows so that the custom group is put into its natural order.
        See Also:
        Constant Field Values

      • DssXmlSortValue

        static final int DssXmlSortValue
        The sort can only be used in an expression and it sorts the data that to which we want to apply the OLAP function so that it is in ascending/descending order.
        See Also:
        Constant Field Values

      • DssXmlSortCustomGroupForm

        static final int DssXmlSortCustomGroupForm
        The sort discriminates on the value of a form of a custom group.
        See Also:
        Constant Field Values

      • DssXmlSortConsolidationForm

        static final int DssXmlSortConsolidationForm
        The sort discriminates on the value of a form of a consolidation.
        See Also:
        Constant Field Values

      • DssSortByCustomOrderOnRA

        static final int DssSortByCustomOrderOnRA
        The sort discriminates on the custom order for Recursive Attribute.
        See Also:
        Constant Field Values

      • DssSortByCustomOrderOnRANDE

        static final int DssSortByCustomOrderOnRANDE
        The sort discriminates on the custom order for New Derived Element on Recursive Attribute.
        See Also:
        Constant Field Values