public interface

WebDrillActions

com.microstrategy.web.objects.WebDrillActions

Class Overview

The WebDrillActions interface represents a collection of drill actions. The collection holds an ordered sequence of drill actions for a WebDrillInstance. This object cannot be directly instantiated, and can be obtained from WebDrillInstance or WebDrillPath.

Summary

Public Methods
abstract WebDrillAction add(int drillType)
Creates a new WebDrillAction object of the type passed as parameter, adds it to the end of the collection of drill action, and returns it.
abstract void clear()
Removes all drill actions from the collection.
abstract Enumeration elements()
Returns a java.util.Enumeration which can be used to iterate through the list of drill actions in the collection.
abstract WebDrillAction get(int index)
Returns the WebDrillAction object at the given index.
abstract boolean isEmpty()
Returns true if there are no drill action in this collection, false if there are one or more drill actions in the collection.
abstract WebDrillAction remove(int index)
Removes the WebDrillAction object with the given index from the collection, and returns the removed element.
abstract boolean remove(WebDrillAction action)
Removes the given WebDrillAction object from the collection.
abstract int size()
Returns the number of drill actions currently in the collection.

Public Methods

public abstract WebDrillAction add (int drillType)

Creates a new WebDrillAction object of the type passed as parameter, adds it to the end of the collection of drill action, and returns it.

Parameters
drillType The type of drill action to be added. Possible drill types are listed in EnumDSSXMLDrillType
Returns
Throws
UnsupportedOperationException If the drill type passed is not supported.

public abstract void clear ()

Removes all drill actions from the collection.

public abstract Enumeration elements ()

Returns a java.util.Enumeration which can be used to iterate through the list of drill actions in the collection. Note that this is the only way to iterate through the collection.

Returns
  • An Enumeration which allows iteration through the collection.

public abstract WebDrillAction get (int index)

Returns the WebDrillAction object at the given index.

Parameters
index The index of the drill action in the collection.
Returns
  • The WebDrillAction object corresponding to the given index in the collection.
Throws
IndexOutOfBoundsException Thrown if the given index is out of the bounds of the collection.
IndexOutOfBoundsException if the index passed is negative or out of bounds.

public abstract boolean isEmpty ()

Returns true if there are no drill action in this collection, false if there are one or more drill actions in the collection.

Returns
  • Whether the collection is empty.

public abstract WebDrillAction remove (int index)

Removes the WebDrillAction object with the given index from the collection, and returns the removed element.

Parameters
index The index of the drill action in the collection to remove.
Returns
Throws
IndexOutOfBoundsException Thrown if the given index is out of the bounds of the collection.

public abstract boolean remove (WebDrillAction action)

Removes the given WebDrillAction object from the collection. Returns the removed drill action.

Parameters
action The WebDrillAction object to remove from the collection.
Returns
Throws
IllegalArgumentException Thrown if the drill action does not exist in the collection.

public abstract int size ()

Returns the number of drill actions currently in the collection.

Returns
  • The current number of drill action in the collection.