public interface

WebElement

implements WebDisplayUnit
com.microstrategy.web.objects.WebElement

Class Overview

The WebElement interface represents a single element. Generally, these objects are stored in an WebElements object. This object is not directly instantiatable - it can only be obtained from WebElements and WebTemplateUnit.

Summary

Public Methods
abstract WebAttribute getAttribute()
Returns the attribute of the element return WebAttribute
abstract String getBrowseFormValue(WebAttributeForm form)
Returns the form value of the specified browse form.
abstract String[] getBrowseFormValues()
Returns a String array of browse form values.
abstract String getConsolidationID()
Returns the consolidation id if the element comes from a New DE.
abstract String getDisplayName()
Returns the current element's display name.
abstract String getElementID()
Returns the ID of the element.
abstract int getElementType()
Returns the type of the element, from EnumDSSXMLElementType.
abstract int getKey()
Returns the key of this element, if it is part of a collection.
abstract int getLevel()
Returns element level.
abstract String getRawValue()
Returns raw value if one is associated with this element
abstract int getSemantics()
Returns header's semantics if one is associated with the element.
abstract WebObjectInfo getTarget()
Returns underlying object to which this element belongs.
abstract String getTerseID()
Returns the element id as defined in the xml response
abstract String getWeight()
Returns weight value if one is associated with this element
abstract boolean hasChildren()
abstract boolean isNullElement()
abstract void setConsolidationID(String consolidationID)
Sets the consolidation id if the element comes from a New DE.
abstract void setDisplayName(String elementName)
Sets the current element name.
abstract void setHasChildren(boolean value)
abstract void setLevel(int value)
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit

Public Methods

public abstract WebAttribute getAttribute ()

Returns the attribute of the element return WebAttribute

public abstract String getBrowseFormValue (WebAttributeForm form)

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.

public abstract 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

public abstract String getConsolidationID ()

Returns the consolidation id if the element comes from a New DE.

Returns
  • The consolidation id.

public abstract String getDisplayName ()

Returns the current element's display name.

Returns
  • The current element name.

public abstract String getElementID ()

Returns the ID of the element.

Returns
  • The element ID.

public abstract int getElementType ()

Returns the type of the element, from EnumDSSXMLElementType. For elements on a template, the overall type of a WebElement is a combination of its getElementType() and getTemplateUnitType(WebElement).

Returns
  • The type of the element.

public abstract 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.

public abstract int getLevel ()

Returns element level. For non-recursive attributes this value will always be 0.

public abstract String getRawValue ()

Returns raw value if one is associated with this element

Returns
  • String containing raw value of element

public abstract int getSemantics ()

Returns header's semantics if one is associated with the element.

public abstract WebObjectInfo getTarget ()

Returns underlying object to which this element belongs.

public abstract String getTerseID ()

Returns the element id as defined in the xml response

Returns
  • The element id.

public abstract String getWeight ()

Returns weight value if one is associated with this element

Returns
  • String containing weight value of element

public abstract boolean hasChildren ()

public abstract boolean isNullElement ()

public abstract void setConsolidationID (String consolidationID)

Sets the consolidation id if the element comes from a New DE.

Parameters
consolidationID The consolidation id.

public abstract void setDisplayName (String elementName)

Sets the current element name.

Parameters
elementName The new name for the element.
See Also

public abstract void setHasChildren (boolean value)

public abstract void setLevel (int value)