Package com.microstrategy.web.beans

Interface HighlightedObjects

  • public interface HighlightedObjects
    This interface is a typical collection interface of HighlightedObject.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      HighlightedObject add​(java.lang.String objectId, int objectType)
      Appends a HighlightedObject into the collection.
      void clear()
      Removes all of the HighlightedObject from the collection.
      boolean contains​(HighlightedObject ho)
      Returns true if the collection contains the specified HighlightedObject
      HighlightedObject get​(int index)
      Returns the HighlightedObject at the specified position.
      boolean isEmpty()
      Tests if this collection has no HighlightedObject
      void remove​(int index)
      Removes the HighlightedObject at the specified position from the collection
      boolean remove​(HighlightedObject ho)
      Removes the specified HighlightedObject from the collection
      int size()
      Returns the number of HighlightedObject in this collection

    • Method Detail

      • add

        HighlightedObject add​(java.lang.String objectId,
                      int objectType)
        Appends a HighlightedObject into the collection.
        Parameters:
        objectId - the object id of the HighlightedObject.
        objectType - the type of the HighlightedObject. It is either EnumDSSXMLObjectTypes or EnumWebDependentObjectType.
        Returns:
        the HighlightedObject added.

      • remove

        boolean remove​(HighlightedObject ho)
        Removes the specified HighlightedObject from the collection
        Parameters:
        ho - the HighlightedObject to be removed
        Returns:
        true if the collection contains the specified HighlightedObject

      • remove

        void remove​(int index)
        Removes the HighlightedObject at the specified position from the collection
        Parameters:
        index - the index to the HighlightedObject to be removed
        Throws:
        java.lang.IndexOutOfBoundsException - if the index is out of range

      • get

        HighlightedObject get​(int index)
        Returns the HighlightedObject at the specified position.
        Parameters:
        index - the position of a HighlightedObject in the collection
        Returns:
        the HighlightedObject at the specified position.
        Throws:
        java.lang.IndexOutOfBoundsException - if the index is out of range

      • contains

        boolean contains​(HighlightedObject ho)
        Returns true if the collection contains the specified HighlightedObject
        Parameters:
        ho - the HighlightedObject whose presence in this collection is to be tested
        Returns:
        true if the collection contains the specified object

      • clear

        void clear()
        Removes all of the HighlightedObject from the collection. This collection will be empty after this call returns.

      • size

        int size()
        Returns the number of HighlightedObject in this collection
        Returns:
        the number of HighlightedObject in this collection

      • isEmpty

        boolean isEmpty()
        Tests if this collection has no HighlightedObject
        Returns:
        true if this colleciton has no HighlightedObject