public interface

WebDrillPath

com.microstrategy.web.objects.WebDrillPath

Class Overview

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.

Summary

Public Methods
abstract String getDescription()
Returns the description string for this drill path.
abstract int getDisplayMode()
returns the display mode for the report upon execution of the drill path possible values are in
abstract WebDrillActions getDrillActions()
Returns the WebDrillActions object in this drill path.
abstract int getDrillType()
abstract int getID()
Returns the ID of this drill path.
abstract int getImportance()
Returns the importance index for this drill path.
abstract String getKey()
abstract String getName()
Returns the name of this drill path.
abstract WebObjectInfo getPathObject()
Returns the WebObjectInfo for the drill path, if any.
abstract String getSetName()
Returns the name of the Set/Group that this drill path belongs to.
abstract boolean isDrillWithin()
Indicates if this drill path will result in a drill within the document or within the cube report of the view filter.

Public Methods

public abstract String getDescription ()

Returns the description string for this drill path.

Returns
  • The description string for this drill path.

public abstract int getDisplayMode ()

returns the display mode for the report upon execution of the drill path possible values are in

public abstract 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

public abstract int getDrillType ()

public abstract int getID ()

Returns the ID of this drill path.

Returns
  • the ID of this drill path.

public abstract int getImportance ()

Returns the importance index for this drill path.

Returns

public abstract String getKey ()

public abstract String getName ()

Returns the name of this drill path.

Returns
  • The name of this drill path.

public abstract 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.

public abstract 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.

public abstract 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.