public interface

EnumDrillEditorEvents

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

Class Overview

All event definitions used in drill editor bean

Summary

Constants
int WebEventAdvDrillEditorProcess This event is used for two purposes.
int WebEventArgumentAdvDrillAttributeDrillPaths Argument to specify the drill key for the advanced drill editor.
int WebEventArgumentAdvDrillChangeDimensionImageName Argument to specify the name of the image used to show the change dimension button on the Advanced Drill Editor.
int WebEventArgumentAdvDrillDimensionName Argument to specify the name of the dimentsion for the Advanced Drill Editor.
int WebEventArgumentAdvDrillSubmitImageName Argument to specify the name of the image used to show the process advanced drill button on the Advanced Drill Editor.
int WebEventArgumentDrillElementList Argument to specify the list of elements on which the user wants to filter the drill.
int WebEventArgumentDrillImageName Argument to specify the name of the check box image on the drill editor.
int WebEventArgumentDrillKeepParent Argument to specify if we need to keep the parent element after drilling.
int WebEventArgumentDrillKey Argument to specify the drill key for Drill Editor.
int WebEventArgumentOptimizedDrillPathInfo Argument to specify the drill path key passed in optimized format.
int WebEventDrillEditorProcess Event to process the Drill Editor Form.
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.EnumPageEvents
From interface com.microstrategy.web.app.beans.EnumServletEvents

Constants

public static final int WebEventAdvDrillEditorProcess

This event is used for two purposes.
It is used to process the Advanced Drill Editor Form and it is also used to change the dimension shown in the Advanced Drill Editor. Based on whether the user has clicked on the chnage dimension button or process Advanced Drill button, we will decide which event to process.

Constant Value: 23002 (0x000059da)

public static final int WebEventArgumentAdvDrillAttributeDrillPaths

Argument to specify the drill key for the advanced drill editor. This argument is made up of 5 different arguments and has a structure associated with it. These arguments are comma "," seperated.
Usage:
The drill key is made up of five different arguments.
Axis - The first argument is the axis of the template unit on which the user wants to drill. Allowed values are specified in EnumDSSXMLAxisName
Position - The second argument is the position of the template unit within the axis. This value is 1-based
Ordinal - The third argument is the ordinal of the template unit.
DrillPathID - The fourth argument is the Drill Path ID of the template unit.
Retain Thresholds - The fifth argument specifies if we need to retain thresholds after drilling. A value of "1" is used to denote Retain Thresholds.

Constant Value: 23008 (0x000059e0)

public static final int WebEventArgumentAdvDrillChangeDimensionImageName

Argument to specify the name of the image used to show the change dimension button on the Advanced Drill Editor.
If this argument is present in the request keys we will process the change dimension event. This argument will be present in the request keys only if the user clicks on it.

Constant Value: 23006 (0x000059de)

public static final int WebEventArgumentAdvDrillDimensionName

Argument to specify the name of the dimentsion for the Advanced Drill Editor. This argument is used for changing the dimension shown in the Advanced Drill Editor. The Advanced Drill Editor will show all the drill paths corresponding the dimension shown.

Constant Value: 23005 (0x000059dd)

public static final int WebEventArgumentAdvDrillSubmitImageName

Argument to specify the name of the image used to show the process advanced drill button on the Advanced Drill Editor.
If this argument is present in the request keys we will process the advanced drill event. This argument will be present in the request keys only if the user clicks on it.

Constant Value: 23007 (0x000059df)

public static final int WebEventArgumentDrillElementList

Argument to specify the list of elements on which the user wants to filter the drill. The list of elements is seperated by a seperator as specified in METRIC_ELEM_LIST_SEPARATOR. The Id of the element is retrieved from WebHeader.

Constant Value: 23002 (0x000059da)

public static final int WebEventArgumentDrillImageName

Argument to specify the name of the check box image on the drill editor. On the drill editor we show all the drill paths for all the titles and each drill is specified with a check image next to it. This image name is used to know which check image the user clicked on, which in turn is used to determine the corresponding drill action.

Constant Value: 23004 (0x000059dc)

public static final int WebEventArgumentDrillKeepParent

Argument to specify if we need to keep the parent element after drilling. The value for Retain Parent is specified in DRILL_RETAIN_PARENT

Constant Value: 23003 (0x000059db)

public static final int WebEventArgumentDrillKey

Argument to specify the drill key for Drill Editor. This argument is made up of 4 different arguments and has a structure associated with it. These arguments are seperated by a seperator which is defined in DRILL_TO_KEY_SEPARATOR.
Usage:
The drill key is made up of four different arguments. Axis - The first argument is the axis of the template unit on which the user wants to drill. Allowed values are specified in EnumDSSXMLAxisName
Position - The second argument is the position of the template unit within the axis. This value is 1-based
Ordinal - The third argument is the ordinal of the template unit.
DrillPathID - The fourth argument is the Drill Path ID of the template unit.

Constant Value: 23001 (0x000059d9)

public static final int WebEventArgumentOptimizedDrillPathInfo

Argument to specify the drill path key passed in optimized format. This argument should be used to pass the key obtained from the optimized drill path framework. If drill key corresponds to the old framework use WebEventArgumentDrillKey instead. This argument is made up of 2 different arguments and has a structure associated with it. These arguments are seperated by a seperator which is defined in DRILL_TO_KEY_SEPARATOR.
Usage:
The drill key is made up of two different arguments. Drill Path Key - This should be the key for the drill path that can be obtained using getKey()
Retain Thresholds - The second argument specifies if we need to retain thresholds after drilling. A value of "1" is used to denote Retain Thresholds. 0 specifies not to retain thresholds. Any other value instructs to use the value from the report definition.

Constant Value: 23009 (0x000059e1)

public static final int WebEventDrillEditorProcess

Event to process the Drill Editor Form.

Constant Value: 23001 (0x000059d9)