Package com.microstrategy.web.objects

Interface WebDrillPath

  • public interface WebDrillPath
    The WebDrillPath interface holds a drill path. A drill path describes a path that a user might want to follow when the user wants to drill on a report. A drill path consists of drill action (or a chain of drill actions), presentation information and its importance index.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getDrillActions

        WebDrillActions getDrillActions()
        Returns the WebDrillActions object in this drill path. The drill actions object thus returned is a collection of a linear chain of drill actions for this drill path.
        Returns:
        The WebDrillActions object.

      • getName

        java.lang.String getName()
        Returns the name of this drill path.
        Returns:
        The name of this drill path.

      • getDescription

        java.lang.String getDescription()
        Returns the description string for this drill path.
        Returns:
        The description string for this drill path.

      • getImportance

        int getImportance()
        Returns the importance index for this drill path.
        Returns:
        The importance index of this drill path. The possible values are listed in EnumDSSXMLDrillImportance

      • getSetName

        java.lang.String getSetName()
        Returns the name of the Set/Group that this drill path belongs to.
        Returns:
        The name of the group/set that this drill path belongs to.

      • getID

        int getID()
        Returns the ID of this drill path.
        Returns:
        the ID of this drill path.

      • getPathObject

        WebObjectInfo getPathObject()
        Returns the WebObjectInfo for the drill path, if any. This call can return null.
        Returns:
        the path object for the drill path, if any.

      • getKey

        java.lang.String getKey()
        Since:
        MicroStrategy Web 8.0.0

      • getDrillType

        int getDrillType()
        Since:
        MicroStrategy Web 8.0.0

      • getDisplayMode

        int getDisplayMode()
        returns the display mode for the report upon execution of the drill path possible values are in
        Since:
        MicroStrategy Web 8.0.1

      • isDrillWithin

        boolean isDrillWithin()
        Indicates if this drill path will result in a drill within the document or within the cube report of the view filter.
        Returns:
        true If this drill path will result in a drill within the document or within the cube report of the vview filter.
        Since:
        MicroStrategy Web 9.0.0