Package com.microstrategy.web.objects
Interface WebDrillAction
-
- All Known Subinterfaces:
WebGraphCoordinatesDrillAction
,WebNewFormsDrillAction
,WebNewObjectDrillAction
,WebRemoveMetricDrillAction
public interface WebDrillAction
This interface is used to hold the drill actions for report drilling. A drill action can be one of the types listed underEnumDSSXMLDrillType
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.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebTemplateUnit
getDrillTemplateUnit()
Returns the template unit that has been set on this instance.int
getDrillType()
Returns the type of the drill action specified by this object.int
getDrillUnitSource()
Returns the Drill Unit Source set for the current drill action.boolean
getFilterMetrics()
Returns the value of the filterMetrics property of this drill action.int
getKeepIndependent()
Returns the keepIndependent property for the current drill action.boolean
getKeepOriginal()
Returns the keepOriginal property for this drill action.boolean
getKeepThresholds()
Returns the keepThresholds property for this drill action.java.lang.String
getName()
Returns the name of the current drill actionint
getReportFilter()
Returns the value of the reportFilter property set for this drill action.int
getUserFilter()
Returns the value of the userFilter for this drill action.void
setDrillTemplateUnit(int axis, int position)
Sets the template unit from where to drill on the base report instance.void
setDrillTemplateUnit(WebTemplateUnit wtu)
Sets the template unit from where to drill on the base report instance.void
setDrillUnitSource(int drillUnitSource)
Set the Drill Unit Source for the current drill action.void
setFilterMetrics(boolean filterMetrics)
Sets the filterMetrics property for the current drill action.void
setKeepIndependent(int keepIndependent)
Sets the keepIndependent property for the current drill action.void
setKeepOriginal(boolean keepOriginal)
Sets the keepOriginal property for the current drill action.void
setKeepThresholds(boolean keepThresholds)
Sets the keepThresholds property for the current drill action.void
setName(java.lang.String name)
Sets the name of the current drill actionvoid
setReportFilter(int reportFilter)
Sets the reportFilter property of the current drill action.void
setUserFilter(int userFilter)
Sets the userFilter property for the current drill action.
-
-
-
Method Detail
-
getDrillTemplateUnit
WebTemplateUnit getDrillTemplateUnit() throws WebObjectsException
Returns the template unit that has been set on this instance.- Returns:
- The
WebTemplateUnit
object set on this object. - Throws:
WebObjectsException
-
setDrillTemplateUnit
void setDrillTemplateUnit(WebTemplateUnit wtu)
Sets the template unit from where to drill on the base report instance.- Parameters:
wtu
- TheWebTemplateUnit
from where to drill.
-
setDrillTemplateUnit
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 theWebTemplateUnit
, from where to drill, lies. Possible enumerations are listed inEnumDSSXMLAxisName
position
- The position of theWebTemplateUnit
on the axis.
-
getFilterMetrics
boolean getFilterMetrics()
Returns the value of the filterMetrics property of this drill action.- Returns:
- The value of the filterMetrics flag for this object.
-
setFilterMetrics
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.
-
getKeepOriginal
boolean getKeepOriginal()
Returns the keepOriginal property for this drill action.- Returns:
- The value of the keepOriginal flag for this object.
-
setKeepOriginal
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 users 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.
-
getKeepThresholds
boolean getKeepThresholds()
Returns the keepThresholds property for this drill action.- Returns:
- The value of the keepThresholds flag for this object.
-
setKeepThresholds
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.
-
getDrillType
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
-
getReportFilter
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
-
setReportFilter
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 inEnumDSSXMLReportFilter
Default value :EnumDSSXMLReportFilter.DssXmlReportFilterSmart
- Parameters:
reportFilter
- The value of the reportFilter property to be set for this object
-
getUserFilter
int getUserFilter()
Returns the value of the userFilter for this drill action.- Returns:
- The value of the userFilter property set for this object.
-
setUserFilter
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 underEnumDSSXMLUserFilter
Default value :EnumDSSXMLUserFilter.DssXmlUserFilterRelation
- Parameters:
userFilter
- The value of the userFilter property to be set for this object.
-
setKeepIndependent
void setKeepIndependent(int keepIndependent)
Sets the keepIndependent property for the current drill action.
Possible values are listed underEnumDSSXMLKeepIndependent
Default value :EnumDSSXMLKeepIndependent.DssXmlKeepIndependentSet
- Parameters:
keepIndependent
- The value of the keepIndependent property to be set for this object.
-
getKeepIndependent
int getKeepIndependent()
Returns the keepIndependent property for the current drill action.
Possible values are listed underEnumDSSXMLKeepIndependent
Default value :EnumDSSXMLKeepIndependent.DssXmlKeepIndependentSet
- Returns:
- The value of the keepIndependent property set.
-
getName
java.lang.String getName()
Returns the name of the current drill action- Returns:
- The name of the drill action hold by this object.
-
setName
void setName(java.lang.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.
-
getDrillUnitSource
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 underEnumDSSXMLDrillUnitSource
Default value :EnumDSSXMLDrillUnitSource.DssXmlDrillUnitInstance
- Returns:
- The Drill Unit Source for this object.
-
setDrillUnitSource
void setDrillUnitSource(int drillUnitSource) throws java.lang.UnsupportedOperationException
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 underEnumDSSXMLDrillUnitSource
Default value :EnumDSSXMLDrillUnitSource.DssXmlDrillUnitInstance
- Parameters:
drillUnitSource
- The Drill Unit Source to be set for this object.- Throws:
java.lang.UnsupportedOperationException
-
-