Package com.microstrategy.web.objects

Interface WebSort

All Known Subinterfaces:

WebDefaultSort, WebFormSort, WebFormSortConfig, WebMetricHierarchicalSort, WebMetricHierarchicalSortConfig, WebMetricSort, WebMetricSortConfig, WebSortConfig

All Known Implementing Classes:

WebMetricHierarchicalSortConfigImpl

public interface WebSort

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.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

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

Method Detail

getKey

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.

getPosition

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.

getSortType

int getSortType()

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

Returns:

The sort type, values from EnumDSSXMLSortType.

isAscending

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.

setAscending

void setAscending(boolean ascending)

Sets the sort order to ascending or not.

Parameters:

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

getSubtotalsPosition

int getSubtotalsPosition()

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

Returns:

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

See Also:

setSubtotalsPosition(int)

setSubtotalsPosition

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.

See Also:

getSubtotalsPosition()

getTarget

WebObjectInfo getTarget()

Returns the target of this sort

Returns:

setRespectParent

void setRespectParent(boolean value)

Sets the Respect Parent flag

Parameters:

value - value

getRespectParent

boolean getRespectParent()

Returns the Respect Parent flag

Returns: