Package com.microstrategy.web.objects

Interface WebDimensionAttribute

  • All Superinterfaces:
    KeyedObject, WebDisplayUnit
    All Known Subinterfaces:
    WebBrowseHierarchyItem
    public interface WebDimensionAttribute
extends WebDisplayUnit
    The WebDimensionAttribute interface represents an attribute within a dimension. It contains methods which are relevant to the relationship between the attribute and the owner dimension.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getAttribute

        WebAttribute getAttribute()
        Returns the attribute which is associated with this object.
        Returns:
        The WebAttribute object which is associated with this WebDimensionAttribute.

      • isEntryPoint

        boolean isEntryPoint()
        Returns whether this attribute is an entry point into the dimension.
        Returns:
        Whether this attribute is an entry point.

      • getParents

        SimpleList getParents()
        Returns the list of parent attributes of this attribute within the associated dimension.
        Returns:
        A SimpleList object, which contains all parent attributes of the associated attribute.

      • getChildren

        SimpleList getChildren()
        Returns the list of child attributes of this attribute within the associated dimension.
        Returns:
        A SimpleList object, which contains all child attributes of the associated attribute.

      • getFilters

        SimpleList getFilters()
        Returns the list of filters defined for the attribute in this dimention.
        Returns:
        A SimpleList object, which contains all filters defined for the attribute in this dimention.

      • getDiplayUnitFilters

        WebDisplayUnits getDiplayUnitFilters()
        Since:
        MicroStrategy Web 9.0.0

      • getFilter

        WebFilter getFilter()
        Returns the suggested filter on this attribute within the associated dimension.
        Returns:
        A WebFilter object which gives the filter expression that was suggested to be used when browsing on the elements of this attribute within the context of the associated dimension.

      • setFilter

        void setFilter​(WebFilter filter)
        throws WebObjectsException
        Sets the current filter for the attribute. The filter must be one of filters in the filters collection or exception will be thrown.
        Parameters:
        filter - the filter to become current.
        Throws:
        WebObjectsException - if provided filter doe not belong to this attribute filters collection

      • getLockType

        int getLockType()
        Returns the type of lock which is on the attribute. This value comes from EnumDSSXMLAttributeLockType.
        Returns:
        The current lock type.

      • getLockLimit

        int getLockLimit()
        Returns the lock limit of the attribute, which is the maximum number of elements which can be retrieved if the lock type is of type limit.
        Returns:
        The lock limit, if applicable. This value will be 0 if the lock type is incorrect.

      • getLockReason

        java.lang.String getLockReason()
        Returns the lock reason for this attribute. This is a string which the Intelligence Server may send which tells what the reason is for the lock on the attribute.
        Returns:
        The lock reason for the attribute.

      • getDimension

        WebDimension getDimension()
        Returns the WebDimension object associated with this dimension attribute.
        Returns:
        The dimension associated with the current instance of the dimension attribute.

      • getDrillableUnits

        WebDisplayUnits getDrillableUnits()
        Returns the children attributes of the attribute within the associated dimension
        Since:
        MicroStrategy Web 9.0.0