Package com.microstrategy.web.objects

Interface WebElement

    • Method Detail

      • getKey

        int getKey()
        Returns the key of this element, if it is part of a collection. If it is not part of a WebElements collection, then this will be 0. A valid key will be a positive integer.
        Returns:
        The current key of this element, or 0 if it is not in a collection.

      • getElementID

        java.lang.String getElementID()
        Returns the ID of the element.
        Returns:
        The element ID.

      • setDisplayName

        void setDisplayName​(java.lang.String elementName)
        Sets the current element name.
        Specified by:
        setDisplayName in interface WebDisplayUnit
        Parameters:
        elementName - The new name for the element.
        See Also:
        getDisplayName()

      • getDisplayForm

        java.lang.String getDisplayForm()
        Returns the current element's display forms.
        Returns:
        The current element forms.
        See Also:
        setDisplayForm(java.lang.String)

      • setDisplayForm

        void setDisplayForm​(java.lang.String elementForm)
        Sets the current element form.
        Parameters:
        elementForm - The new form for the element.
        See Also:
        getDisplayForm()

      • getBrowseFormValues

        java.lang.String[] getBrowseFormValues()
        Returns a String array of browse form values. Browse form values are used in order to construct element's display name if the XML retrieved from the Intelligence Server does not have display name for elements.
        Returns:
        Returns a String array of browse form values
        Since:
        MicroStrategy Web 8.0.0

      • getBrowseFormValue

        java.lang.String getBrowseFormValue​(WebAttributeForm form)
                             throws WebObjectsException
        Returns the form value of the specified browse form. It returns null if the value does not exist.
        Parameters:
        form - the browse form.
        Returns:
        the form value. null if the value does not exist.
        Throws:
        WebObjectsException - if the origin of this element can not be obtained or the origin is not an attribute.
        Since:
        MicroStrategy Web 8.0.1

      • getAttribute

        WebAttribute getAttribute()
        Returns the attribute of the element return WebAttribute
        Since:
        MicroStrategy Web 9.0.0

      • getTarget

        WebObjectInfo getTarget()
        Returns underlying object to which this element belongs.

      • getRawValue

        java.lang.String getRawValue()
        Returns raw value if one is associated with this element
        Returns:
        String containing raw value of element

      • getLevel

        int getLevel()
        Returns element level. For non-recursive attributes this value will always be 0.
        Parameters:
        value - element level

      • setLevel

        void setLevel​(int value)

      • setHasChildren

        void setHasChildren​(boolean value)

      • hasChildren

        boolean hasChildren()

      • getParentElementID

        java.lang.String getParentElementID()
        Returns the ID of its parent element.
        Returns:
        The parent element ID.

      • setParentElementID

        void setParentElementID​(java.lang.String value)

      • isHidden

        boolean isHidden()

      • setHidden

        void setHidden​(boolean value)

      • isExpanded

        boolean isExpanded()

      • setExpanded

        void setExpanded​(boolean value)

      • setLeafNode

        void setLeafNode​(boolean value)

      • isLeafNode

        boolean isLeafNode()

      • setParentElementIndex

        void setParentElementIndex​(int value)

      • getParentElementIndex

        int getParentElementIndex()

      • getConstructedElementID

        java.lang.String getConstructedElementID()
        Retruns the Element ID ensuring that it is properly constructed with the following format; "h1;8D679D4B11D3E4981000E787EC6DE8A4;Northeast" is an example. It consists of ";;display name".
        Returns:

      • getSemantics

        int getSemantics()
        Returns header's semantics if one is associated with the element.

      • getWeight

        java.lang.String getWeight()
        Returns weight value if one is associated with this element
        Returns:
        String containing weight value of element

      • isNullElement

        boolean isNullElement()
        Since:
        MicroStrategy Web 9.3.2

      • getConsolidationID

        java.lang.String getConsolidationID()
        Returns the consolidation id if the element comes from a New DE.
        Returns:
        The consolidation id.

      • setConsolidationID

        void setConsolidationID​(java.lang.String consolidationID)
        Sets the consolidation id if the element comes from a New DE.
        Parameters:
        consolidationID - The consolidation id.

      • getTerseID

        java.lang.String getTerseID()
        Returns the element id as defined in the xml response
        Returns:
        The element id.