Package com.microstrategy.web.objects

Interface WebDrillActions

  • public interface WebDrillActions
    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.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      void clear()
      Removes all drill actions from the collection.
      java.util.Enumeration elements()
      Returns a java.util.Enumeration which can be used to iterate through the list of drill actions in the collection.
      WebDrillAction get​(int index)
      Returns the WebDrillAction object at the given index.
      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.
      WebDrillAction remove​(int index)
      Removes the WebDrillAction object with the given index from the collection, and returns the removed element.
      boolean remove​(WebDrillAction action)
      Removes the given WebDrillAction object from the collection.
      int size()
      Returns the number of drill actions currently in the collection.

    • Method Detail

      • add

        WebDrillAction add​(int drillType)
            throws java.lang.UnsupportedOperationException
        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:
        The new WebDrillAction object added.
        Throws:
        java.lang.UnsupportedOperationException - If the drill type passed is not supported.

      • get

        WebDrillAction get​(int index)
            throws java.lang.IndexOutOfBoundsException
        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:
        java.lang.IndexOutOfBoundsException - Thrown if the given index is out of the bounds of the collection.
        java.lang.IndexOutOfBoundsException - if the index passed is negative or out of bounds.

      • remove

        WebDrillAction remove​(int index)
               throws java.lang.IndexOutOfBoundsException
        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:
        The WebDrillAction object that has been removed from the collection..
        Throws:
        java.lang.IndexOutOfBoundsException - Thrown if the given index is out of the bounds of the collection.

      • remove

        boolean remove​(WebDrillAction action)
        throws java.lang.IllegalArgumentException
        Removes the given WebDrillAction object from the collection. Returns the removed drill action.
        Parameters:
        action - The WebDrillAction object to remove from the collection.
        Returns:
        The WebDrillAction object that is removed.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the drill action does not exist in the collection.

      • clear

        void clear()
        Removes all drill actions from the collection.

      • isEmpty

        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.

      • size

        int size()
        Returns the number of drill actions currently in the collection.
        Returns:
        The current number of drill action in the collection.

      • elements

        java.util.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.