Package com.microstrategy.web.app.beans

Class SortDefinition

  • public class SortDefinition
extends java.lang.Object

    Title: SortDefinition.

    Description: The class represents the definition of a Subtotal as supported by the subtotals editor

    Copyright: Copyright (c) 2004

    Company: Microstrategy, Inc.

    Since:
    MicroStrategy Web 8.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int SORT_ASCENDING
      Constant value indicating sort ascending is to be performed
      static int SORT_DESCENDING
      Constant value indicating sort descending is to be performed
      static int SORT_NONE
      Constant value indicating no sorting in particular is to be performed

    • Constructor Summary

      Constructors 
      Constructor Description
      SortDefinition()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDisplay()  
      java.lang.String getGroupByID()
      Returns the group by id in case the sort is a group by sort of a document.
      int getIndex()  
      boolean getIsDefaultSort()
      Indicates if the sort is the default sort or not.
      int getSortType()  
      int getUnitType()  
      java.lang.String getValue()  
      void setDisplay​(java.lang.String value)
      Sets the name of the sorted by element
      void setGroupByID​(java.lang.String value)
      Sets the group by id in case the sort is a group by sort of a document.
      void setIndex​(int value)
      Sets sort hierarchy order for group by sorts.
      void setIsDefaultSort​(boolean value)
      Indicates if the sort is the default sort or not.
      void setSortType​(int value)
      Sets the type of sort: SORT_NONE, SORT_ASCENDING, SORT_DESCENDING.
      void setUnitType​(int value)
      Sets the object type of the sorted by element.
      void setValue​(java.lang.String value)
      Sets the internal representation of the sorted by element.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • SORT_NONE

        public static final int SORT_NONE
        Constant value indicating no sorting in particular is to be performed
        See Also:
        Constant Field Values

      • SORT_ASCENDING

        public static final int SORT_ASCENDING
        Constant value indicating sort ascending is to be performed
        See Also:
        Constant Field Values

      • SORT_DESCENDING

        public static final int SORT_DESCENDING
        Constant value indicating sort descending is to be performed
        See Also:
        Constant Field Values

    • Constructor Detail

      • SortDefinition

        public SortDefinition()

    • Method Detail

      • setDisplay

        public void setDisplay​(java.lang.String value)
        Sets the name of the sorted by element
        Parameters:
        value - name of the sorted by element

      • getDisplay

        public java.lang.String getDisplay()
        Returns:
        the name of the sorted by element

      • setValue

        public void setValue​(java.lang.String value)
        Sets the internal representation of the sorted by element.
        Parameters:
        value - internal representation of the sorted by.

      • getValue

        public java.lang.String getValue()
        Returns:
        the internal representation of the sorted by element.

      • setIsDefaultSort

        public void setIsDefaultSort​(boolean value)
        Indicates if the sort is the default sort or not.
        Parameters:
        value - true if the sort is the default sort.

      • getIsDefaultSort

        public boolean getIsDefaultSort()
        Indicates if the sort is the default sort or not.
        Returns:
        true if the sort is the default sort.

      • setUnitType

        public void setUnitType​(int value)
        Sets the object type of the sorted by element.
        Parameters:
        value - object type.

      • getUnitType

        public int getUnitType()
        Returns:
        the object type of the sorted by element.

      • setGroupByID

        public void setGroupByID​(java.lang.String value)
        Sets the group by id in case the sort is a group by sort of a document.
        Parameters:
        value - group by id.

      • getGroupByID

        public java.lang.String getGroupByID()
        Returns the group by id in case the sort is a group by sort of a document.
        Returns:
        group by id.

      • setIndex

        public void setIndex​(int value)
        Sets sort hierarchy order for group by sorts.
        Parameters:
        value - integer indicating the order of the sort

      • getIndex

        public int getIndex()
        Returns:
        the sort hierarchy order for group by sorts.