Interface WebDrillAction

    • 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 action
      int 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 action
      void 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

      • setDrillTemplateUnit

        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.
      • 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 the WebTemplateUnit, from where to drill, lies. Possible enumerations are listed in EnumDSSXMLAxisName
        position - The position of the WebTemplateUnit 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 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.
      • 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 in EnumDSSXMLReportFilter

        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 under EnumDSSXMLUserFilter

        Default value : EnumDSSXMLUserFilter.DssXmlUserFilterRelation
        Parameters:
        userFilter - The value of the userFilter property to be set for this object.
      • 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 under EnumDSSXMLDrillUnitSource

        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 under EnumDSSXMLDrillUnitSource

        Default value : EnumDSSXMLDrillUnitSource.DssXmlDrillUnitInstance
        Parameters:
        drillUnitSource - The Drill Unit Source to be set for this object.
        Throws:
        java.lang.UnsupportedOperationException