Interface WebDimension

    • Method Detail

      • get

        WebDimensionAttribute get​(int index)
                           throws java.lang.IndexOutOfBoundsException
        Returns the attribute within the collection with the given index.
        Parameters:
        index - The index of the object to find.
        Returns:
        The WebDimensionAttribute object corresponding to the given index.
        Throws:
        java.lang.IndexOutOfBoundsException - Thrown if the given index is invalid.
      • itemByID

        WebDimensionAttribute itemByID​(java.lang.String attributeDSSID)
                                throws java.lang.IllegalArgumentException
        Searches for an attribute with the given DSSID in the WebDimension collection.
        Parameters:
        attributeDSSID - The DSS ID of the attribute to search for in the dimension.
        Returns:
        The WebDimensionAttribute object with the given DSS ID.
        Throws:
        java.lang.IllegalArgumentException - Thrown if an attribute by the given DSS ID is not found in the dimension.
      • isEmpty

        boolean isEmpty()
        Returns whether the dimension has any attributes.
        Returns:
        True if the dimension has attributes, false if it does not.
      • size

        int size()
        Returns the number of attributes in the dimension collection.
        Returns:
        The size of the dimension collection.
      • elements

        java.util.Enumeration elements()
        Returns a java.util.Enumeration containing the attributes within the collection.
        Returns:
        An Enumeration containing the objects within the dimension.
      • getStyle

        int getStyle()
        Returns the XML style in which the dimension will be output in display XML.
        Returns:
        The current display style of the dimension, from EnumWebDimensionDisplayStyle.
        See Also:
        setStyle(int)
      • setStyle

        void setStyle​(int style)
        Sets the XML style will be used when generating display XML for this dimension.
        Parameters:
        style - The display style to use for the dimension, which should be a value from EnumWebDimensionDisplayStyle.
        See Also:
        getStyle()
      • getTopLevelAttributes

        WebDisplayUnits getTopLevelAttributes()
        Since:
        MicroStrategy Web 9.0.0