public interface

WebDrillAction

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

Class Overview

This interface is used to hold the drill actions for report drilling. A drill action can be one of the types listed under EnumDSSXMLDrillType A WebDrillAction object can be used to represent drill actions of type DrillFixTemplate, DrillToDetails. Its subclasses can be used for drill actions of remaining types : [1] WebRemoveMetricDrillAction for DrillRemoveMetric, [2] WebGraphCoordinatesDrillAction for DrillToGraphCoordinates, [3] WebNewObjectDrillAction for DrillToMetric, DrillToTemplate, DrillToRemoveUnit, DrillToUnit, DrillToChild, DrillToParent, [4] WebNewFormsDrillAction for DrillToForm.

Summary

Public Methods
abstract WebTemplateUnit getDrillTemplateUnit()
Returns the template unit that has been set on this instance.
abstract int getDrillType()
Returns the type of the drill action specified by this object.
abstract int getDrillUnitSource()
Returns the Drill Unit Source set for the current drill action.
abstract boolean getFilterMetrics()
Returns the value of the filterMetrics property of this drill action.
abstract int getKeepIndependent()
Returns the keepIndependent property for the current drill action.
abstract boolean getKeepOriginal()
Returns the keepOriginal property for this drill action.
abstract boolean getKeepThresholds()
Returns the keepThresholds property for this drill action.
abstract String getName()
Returns the name of the current drill action
abstract int getReportFilter()
Returns the value of the reportFilter property set for this drill action.
abstract int getUserFilter()
Returns the value of the userFilter for this drill action.
abstract void setDrillTemplateUnit(int axis, int position)
Sets the template unit from where to drill on the base report instance.
abstract void setDrillTemplateUnit(WebTemplateUnit wtu)
Sets the template unit from where to drill on the base report instance.
abstract void setDrillUnitSource(int drillUnitSource)
Set the Drill Unit Source for the current drill action.
abstract void setFilterMetrics(boolean filterMetrics)
Sets the filterMetrics property for the current drill action.
abstract void setKeepIndependent(int keepIndependent)
Sets the keepIndependent property for the current drill action.
abstract void setKeepOriginal(boolean keepOriginal)
Sets the keepOriginal property for the current drill action.
abstract void setKeepThresholds(boolean keepThresholds)
Sets the keepThresholds property for the current drill action.
abstract void setName(String name)
Sets the name of the current drill action
abstract void setReportFilter(int reportFilter)
Sets the reportFilter property of the current drill action.
abstract void setUserFilter(int userFilter)
Sets the userFilter property for the current drill action.

Public Methods

public abstract WebTemplateUnit getDrillTemplateUnit ()

Returns the template unit that has been set on this instance.

Returns

public abstract int getDrillType ()

Returns the type of the drill action specified by this object.

Returns
  • The type of this WebDrillAction object. The possible drill types are listed in EnumDSSXMLDrillType

public abstract int getDrillUnitSource ()

Returns the Drill Unit Source set for the current drill action.

A Drill Unit Source specifies where the template unit for the drill action be obtained from.
Possible values are listed under EnumDSSXMLDrillUnitSource

Default value : DssXmlDrillUnitInstance

Returns
  • The Drill Unit Source for this object.

public abstract boolean getFilterMetrics ()

Returns the value of the filterMetrics property of this drill action.

Returns
  • The value of the filterMetrics flag for this object.

public abstract int getKeepIndependent ()

Returns the keepIndependent property for the current drill action.

Possible values are listed under EnumDSSXMLKeepIndependent

Default value : DssXmlKeepIndependentSet

Returns
  • The value of the keepIndependent property set.

public abstract boolean getKeepOriginal ()

Returns the keepOriginal property for this drill action.

Returns
  • The value of the keepOriginal flag for this object.

public abstract boolean getKeepThresholds ()

Returns the keepThresholds property for this drill action.

Returns
  • The value of the keepThresholds flag for this object.

public abstract String getName ()

Returns the name of the current drill action

Returns
  • The name of the drill action hold by this object.

public abstract int getReportFilter ()

Returns the value of the reportFilter property set for this drill action.

Returns
  • The value of the reportFilter property for this object. The possible settings are listed in EnumDSSXMLReportFilter

public abstract int getUserFilter ()

Returns the value of the userFilter for this drill action.

Returns
  • The value of the userFilter property set for this object.

public abstract void setDrillTemplateUnit (int axis, int position)

Sets the template unit from where to drill on the base report instance.

Parameters
axis The Axis on which the WebTemplateUnit, from where to drill, lies. Possible enumerations are listed in EnumDSSXMLAxisName
position The position of the WebTemplateUnit on the axis.

public abstract void setDrillTemplateUnit (WebTemplateUnit wtu)

Sets the template unit from where to drill on the base report instance.

Parameters
wtu The WebTemplateUnit from where to drill.

public abstract void setDrillUnitSource (int drillUnitSource)

Set the Drill Unit Source for the current drill action.

A Drill Unit Source specifies where the template unit for the drill action be obtained from.

Possible values are listed under EnumDSSXMLDrillUnitSource

Default value : DssXmlDrillUnitInstance

Parameters
drillUnitSource The Drill Unit Source to be set for this object.
Throws
UnsupportedOperationException

public abstract void setFilterMetrics (boolean filterMetrics)

Sets the filterMetrics property for the current drill action.

Possible values :

True = Modify the template so that it only includes those metrics whose header elements appear in the Elements collection. If the collection does not contain any metric elements, then the metrics on the template are not changed.

False = Do not filter the template to only show the selected metrics.

Default value : True

Parameters
filterMetrics The desired value to be set for the filterMetrics flag of this object.

public abstract void setKeepIndependent (int keepIndependent)

Sets the keepIndependent property for the current drill action.

Possible values are listed under EnumDSSXMLKeepIndependent

Default value : DssXmlKeepIndependentSet

Parameters
keepIndependent The value of the keepIndependent property to be set for this object.

public abstract void setKeepOriginal (boolean keepOriginal)

Sets the keepOriginal property for the current drill action.

Possible values :

False = Replace the user's selection of a template unit.

True = Keep the user’s selection of a template unit. The new template will be added immediately after it on the same axis.

Default Value : False

Parameters
keepOriginal The value of the keepOriginal flag to be set for this object.

public abstract void setKeepThresholds (boolean keepThresholds)

Sets the keepThresholds property for the current drill action.

Possible values :

False = Don't preserve the thresholds after drilling.

True = preserve the thresholds after drilling.

Default Value : False

Parameters
keepThresholds The value of the keepThresholds flag to be set for this object.

public abstract void setName (String name)

Sets the name of the current drill action

Parameters
name The name to be set for the drill action hold by this object.

public abstract void setReportFilter (int reportFilter)

Sets the reportFilter property of the current drill action.

The drill action property reportFilter specifies how the report server uses the report's original filter

Possible values are listed in EnumDSSXMLReportFilter

Default value : DssXmlReportFilterSmart

Parameters
reportFilter The value of the reportFilter property to be set for this object

public abstract void setUserFilter (int userFilter)

Sets the userFilter property for the current drill action.

The drill action property userFilter specifies how the report server uses the user's original filter

Possible values are listed under EnumDSSXMLUserFilter

Default value : DssXmlUserFilterRelation

Parameters
userFilter The value of the userFilter property to be set for this object.