public interface

WebSort

com.microstrategy.web.objects.WebSort
Known Indirect Subclasses

Class Overview

This is the generic sort interface to represent the information shared by all types of sorts. Most sort types implement two interfaces: this interface and another type-specific interface, but for types EnumDSSXMLSortType.DssXmlSortSubtotalsPosition and EnumDSSXMLSortType.DssXmlSortGroupByMetric, this is the only interface available.

Summary

Public Methods
abstract int getKey()
Returns the key of current sort object, which is used to look up the sort in the sorts collection.
abstract int getPosition()
Returns the position of current sort object in the sorts collection.
abstract boolean getRespectParent()
Returns the Respect Parent flag
abstract int getSortType()
Returns the sort type of this sort object.
abstract int getSubtotalsPosition()
Returns the position of subtotals in sorted result.
abstract WebObjectInfo getTarget()
Returns the target of this sort
abstract boolean isAscending()
Returns the sort order, which is ascending or not.
abstract void setAscending(boolean ascending)
Sets the sort order to ascending or not.
abstract void setRespectParent(boolean value)
Sets the Respect Parent flag
abstract void setSubtotalsPosition(int subtotalsPosition)
Sets the position of subtotals in sorted result.

Public Methods

public abstract int getKey ()

Returns the key of current sort object, which is used to look up the sort in the sorts collection. This has nothing to do with the sort-key.

Returns
  • A key can be used to look up a sort in the sorts collection.

public abstract int getPosition ()

Returns the position of current sort object in the sorts collection.

Returns
  • The position (1-based) of current sort object in the sorts collection.

public abstract boolean getRespectParent ()

Returns the Respect Parent flag

public abstract int getSortType ()

Returns the sort type of this sort object. The sort type only can be specified on creation time.

Returns

public abstract int getSubtotalsPosition ()

Returns the position of subtotals in sorted result. The possible value are in EnumDSSXMLSubtotalsPosition. Default is EnumDSSXMLSubtotalsPosition.DssSubtotalsPositionInherit

Returns

public abstract WebObjectInfo getTarget ()

Returns the target of this sort

public abstract boolean isAscending ()

Returns the sort order, which is ascending or not.

Returns
  • True if the result will be sorted in ascending order; else false. Default value is true.

public abstract void setAscending (boolean ascending)

Sets the sort order to ascending or not.

Parameters
ascending True to sort in ascending order, false to descending order.

public abstract void setRespectParent (boolean value)

Sets the Respect Parent flag

Parameters
value value

public abstract void setSubtotalsPosition (int subtotalsPosition)

Sets the position of subtotals in sorted result. The possible value are in EnumDSSXMLSubtotalsPosition. Default is EnumDSSXMLSubtotalsPosition.DssSubtotalsPositionInherit.

Parameters
subtotalsPosition The position of subtotals in sorted result, values from EnumDSSXMLSubtotalsPosition.