public interface

EnumSortEditorEvents

implements EnumPageEvents
com.microstrategy.web.app.beans.EnumSortEditorEvents

Class Overview

All event definitions used in sort editor bean

Summary

Constants
int SORT_ORDER_ASCENDING
int SORT_ORDER_DESCENDING
String SORT_PARAM_SEPARATOR
int WebEventArgumentActiveKey Argument to specify the active key of the selectd view bean.
int WebEventArgumentCurrentTab
int WebEventArgumentGroupBySortCount Indicate the number of Group By sorts included in the request
int WebEventArgumentGroupBySortKey Argument to specify the sort key for Group By sorting in the Report Writer Sort Editor The sort key is made up of three different arguments.
int WebEventArgumentGroupBySortOrder Indicate the Form SOrt Key of the Group By elements.
int WebEventArgumentRespectParent
int WebEventArgumentSortKey Argument to specify the sort key for Sort Editor.
int WebEventArgumentSortOrder Argument to specify the sort order.
int WebEventArgumentSortSubtotalPostion Argument to specify the position of subtotals in sorted result.
int WebEventSortEditorProcess Event to process the Sort Editor Form.
int WebEventSwitchEditorTab
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.EnumPageEvents
From interface com.microstrategy.web.app.beans.EnumServletEvents

Constants

public static final int SORT_ORDER_ASCENDING

Constant Value: 1 (0x00000001)

public static final int SORT_ORDER_DESCENDING

Constant Value: 0 (0x00000000)

public static final String SORT_PARAM_SEPARATOR

Constant Value: ";"

public static final int WebEventArgumentActiveKey

Argument to specify the active key of the selectd view bean.

Constant Value: 24004 (0x00005dc4)

public static final int WebEventArgumentCurrentTab

Constant Value: 24008 (0x00005dc8)

public static final int WebEventArgumentGroupBySortCount

Indicate the number of Group By sorts included in the request

Constant Value: 24006 (0x00005dc6)

public static final int WebEventArgumentGroupBySortKey

Argument to specify the sort key for Group By sorting in the Report Writer Sort Editor The sort key is made up of three different arguments.
Section Key - Indicates the Section ID wehre the attribute is present
Form ID - The second argument is the Attribute Form ID of the template unit on which the user wants to sort.
Sort Order - Indicates the sort order (0. Descending | 1. Ascending)

Constant Value: 24005 (0x00005dc5)

public static final int WebEventArgumentGroupBySortOrder

Indicate the Form SOrt Key of the Group By elements.

Constant Value: 24007 (0x00005dc7)

public static final int WebEventArgumentRespectParent

Constant Value: 24009 (0x00005dc9)

public static final int WebEventArgumentSortKey

Argument to specify the sort key for Sort Editor.
This argument is made up of 5 different arguments and has a structure associated with it. These arguments are seperated by a seperator which is defined in SORT_PARAM_SEPARATOR. The sort key is different for sorting on rows and on columns. Based on what the user is sorting upon, some of these arguments within the sort key will be left blank.
Usage:
The sort key is made up of five different arguments.
Object Type - The first argument is the object type of the template unit on which the user wants to sort. Allowed values are specified in EnumDSSXMLObjectTypes Since we allow sorting only on metrics in the columns, the value of this argument for column sorting is always DssXmlTypeMetric
Object DSSID - The second argument is the DSS ID of the template unit on which the user wants to sort.
Form ID - The third argument is the Attribute Form ID of the template unit on which the user wants to sort. This argument is present only for row sorting and is blank for column sorting.
Form Type - The fourth argument is the Attribute Form Type of the template unit on which the user wants to sort. This argument is present only for row sorting and is blank for column sorting. Allowed values are specified in EnumDSSXMLObjectTypes.
Element List - The fifth argument is the list of elements included in the sort. This argument is present only for column sorting and is blank for row sorting. The list of elements is seperated by SORT_ELEM_LIST_SEPARATOR. This list of elements is used to identify the columns headers used in the sort.

Constant Value: 24001 (0x00005dc1)

public static final int WebEventArgumentSortOrder

Argument to specify the sort order.
The sort order can be ascending or descending. If the value of this argument is "TRUE" then the sort order is ascending. Any other value will denote a descending sort order.

Constant Value: 24002 (0x00005dc2)

public static final int WebEventArgumentSortSubtotalPostion

Argument to specify the position of subtotals in sorted result.
The possible values are in EnumDSSXMLSubtotalsPosition. Default is com.microstrategy.webapi.EnumDSSXMLSubtotalsPosition.DssSubtotalsPositionInherit.

Constant Value: 24003 (0x00005dc3)

public static final int WebEventSortEditorProcess

Event to process the Sort Editor Form.

Constant Value: 24001 (0x00005dc1)

public static final int WebEventSwitchEditorTab

Constant Value: 24002 (0x00005dc2)