public class

SortDefinition

extends Object
java.lang.Object
   ↳ com.microstrategy.web.app.beans.SortDefinition

Class Overview

Title: SortDefinition.

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

Copyright: Copyright (c) 2004

Company: Microstrategy, Inc.

Summary

Constants
int SORT_ASCENDING Constant value indicating sort ascending is to be performed
int SORT_DESCENDING Constant value indicating sort descending is to be performed
int SORT_NONE Constant value indicating no sorting in particular is to be performed
Public Constructors
SortDefinition()
Public Methods
String getDisplay()
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()
String getValue()
void setDisplay(String value)
Sets the name of the sorted by element
void setGroupByID(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(String value)
Sets the internal representation of the sorted by element.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int SORT_ASCENDING

Constant value indicating sort ascending is to be performed

Constant Value: 1 (0x00000001)

public static final int SORT_DESCENDING

Constant value indicating sort descending is to be performed

Constant Value: 2 (0x00000002)

public static final int SORT_NONE

Constant value indicating no sorting in particular is to be performed

Constant Value: 0 (0x00000000)

Public Constructors

public SortDefinition ()

Public Methods

public String getDisplay ()

Returns
  • the name of the sorted by element

public String getGroupByID ()

Returns the group by id in case the sort is a group by sort of a document.

Returns
  • group by id.

public int getIndex ()

Returns
  • the sort hierarchy order for group by sorts.

public boolean getIsDefaultSort ()

Indicates if the sort is the default sort or not.

Returns
  • true if the sort is the default sort.

public int getSortType ()

Returns

public int getUnitType ()

Returns
  • the object type of the sorted by element.

public String getValue ()

Returns
  • the internal representation of the sorted by element.

public void setDisplay (String value)

Sets the name of the sorted by element

Parameters
value name of the sorted by element

public void setGroupByID (String value)

Sets the group by id in case the sort is a group by sort of a document.

Parameters
value group by id.

public void setIndex (int value)

Sets sort hierarchy order for group by sorts.

Parameters
value integer indicating the order of the sort

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.

public void setSortType (int value)

Sets the type of sort: SORT_NONE, SORT_ASCENDING, SORT_DESCENDING.

Parameters
value int value with the type of sort to define

public void setUnitType (int value)

Sets the object type of the sorted by element.

Parameters
value object type.

public void setValue (String value)

Sets the internal representation of the sorted by element.

Parameters
value internal representation of the sorted by.