Package com.microstrategy.web.objects

Interface WebDerivedElements

  • All Known Implementing Classes:
    WebDerivedElementsEditorObject
    public interface WebDerivedElements
    This interface represents a collection of Derived Elements
    Since:
    MicroStrategy Web 9.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void add​(WebDerivedElement de, int position)
      Adds derived element to the collection
      void clear()
      Removes all Derived Elements from the collection.
      boolean contains​(java.lang.String id)
      Returns true if the Derived Element with the given id exists in the collection.
      java.util.Enumeration elements()
      Returns a java.util.Enumeration which can be used to iterate through the list of elements in the collection.
      WebDerivedElement get​(int index)
      Returns the Derived Element object with the given index.
      WebDerivedElement get​(java.lang.String id)
      Returns a Derived Element object with the given id, if it exists.
      WebExpression getDomainExpression()  
      int getInsertPosition()  
      java.lang.String getLinkedObjectName()  
      boolean hasVisibleList()  
      int indexOf​(java.lang.String id)
      Finds the index of Derived Element with the given id.
      boolean isEditable()  
      boolean isLinked()  
      boolean isSort()  
      void moveTo​(java.lang.String id, int position)
      Moves spesified Derived Element to specify position
      WebDerivedElement remove​(int index)
      Removes a derived element located in the index position.
      WebDerivedElement remove​(java.lang.String id)
      Removes the Derived Element object with the given id from the collection;
      int size()
      Returns the number of elements currently in the collection.

    • Method Detail

      • get

        WebDerivedElement get​(int index)
               throws java.lang.IndexOutOfBoundsException
        Returns the Derived Element object with the given index.
        Parameters:
        index - The index of the element in the collection.
        Returns:
        The Derived Element 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.

      • get

        WebDerivedElement get​(java.lang.String id)
               throws java.lang.IllegalArgumentException
        Returns a Derived Element object with the given id, if it exists.
        Parameters:
        id - The key of the element to search for in the collection.
        Returns:
        A Derived Element object in the collection corresponding to the given key.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the element with the given id does not exist in the collection.

      • indexOf

        int indexOf​(java.lang.String id)
        Finds the index of Derived Element with the given id.
        Parameters:
        id - String
        Returns:
        index or -1 if element not found.

      • add

        void add​(WebDerivedElement de,
         int position)
  throws java.lang.IllegalArgumentException,
         java.lang.IndexOutOfBoundsException
        Adds derived element to the collection
        Parameters:
        de - element
        position - position
        Throws:
        java.lang.IllegalArgumentException - Thrown if the element already exists in the collection.
        java.lang.IndexOutOfBoundsException - Thrown if the position is out of bondories.

      • remove

        WebDerivedElement remove​(int index)
                  throws java.lang.IndexOutOfBoundsException
        Removes a derived element located in the index position.
        Parameters:
        index - position
        Returns:
        Removed derived element
        Throws:
        java.lang.IndexOutOfBoundsException - if index is out of bounds

      • remove

        WebDerivedElement remove​(java.lang.String id)
        Removes the Derived Element object with the given id from the collection;
        Parameters:
        id - The element id.

      • moveTo

        void moveTo​(java.lang.String id,
            int position)
     throws java.lang.IllegalArgumentException,
            java.lang.IndexOutOfBoundsException
        Moves spesified Derived Element to specify position
        Parameters:
        id - element ID
        position - new position
        Throws:
        java.lang.IllegalArgumentException - Thrown if the element not found.
        java.lang.IndexOutOfBoundsException - Thrown if the position is out of bondories.

      • clear

        void clear()
        Removes all Derived Elements from the collection.

      • size

        int size()
        Returns the number of elements currently in the collection.
        Returns:
        The current number of elements in the collection.

      • contains

        boolean contains​(java.lang.String id)
        Returns true if the Derived Element with the given id exists in the collection.
        Parameters:
        id - The Derived Element ID.
        Returns:
        Whether the element with the given id exists in the collection.

      • elements

        java.util.Enumeration elements()
        Returns a java.util.Enumeration which can be used to iterate through the list of elements in the collection.
        Returns:
        An Enumeration which allows iteration through the collection.

      • isEditable

        boolean isEditable()

      • getLinkedObjectName

        java.lang.String getLinkedObjectName()

      • isLinked

        boolean isLinked()

      • isSort

        boolean isSort()

      • getInsertPosition

        int getInsertPosition()

      • hasVisibleList

        boolean hasVisibleList()