public interface

WebDimensionAttribute

implements WebDisplayUnit
com.microstrategy.web.objects.WebDimensionAttribute
Known Indirect Subclasses

Class Overview

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.

Summary

Public Methods
abstract WebAttribute getAttribute()
Returns the attribute which is associated with this object.
abstract SimpleList getChildren()
Returns the list of child attributes of this attribute within the associated dimension.
abstract WebDimension getDimension()
Returns the WebDimension object associated with this dimension attribute.
abstract WebDisplayUnits getDiplayUnitFilters()
abstract WebDisplayUnits getDrillableUnits()
Returns the children attributes of the attribute within the associated dimension
abstract WebFilter getFilter()
Returns the suggested filter on this attribute within the associated dimension.
abstract SimpleList getFilters()
Returns the list of filters defined for the attribute in this dimention.
abstract 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.
abstract String getLockReason()
Returns the lock reason for this attribute.
abstract int getLockType()
Returns the type of lock which is on the attribute.
abstract SimpleList getParents()
Returns the list of parent attributes of this attribute within the associated dimension.
abstract boolean isEntryPoint()
Returns whether this attribute is an entry point into the dimension.
abstract void setFilter(WebFilter filter)
Sets the current filter for the attribute.
[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 which is associated with this object.

Returns
  • The WebAttribute object which is associated with this WebDimensionAttribute.

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

public abstract WebDimension getDimension ()

Returns the WebDimension object associated with this dimension attribute.

Returns
  • The dimension associated with the current instance of the dimension attribute.

public abstract WebDisplayUnits getDiplayUnitFilters ()

public abstract WebDisplayUnits getDrillableUnits ()

Returns the children attributes of the attribute within the associated dimension

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

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

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

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

public abstract int getLockType ()

Returns the type of lock which is on the attribute. This value comes from EnumDSSXMLAttributeLockType.

Returns
  • The current lock type.

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

public abstract boolean isEntryPoint ()

Returns whether this attribute is an entry point into the dimension.

Returns
  • Whether this attribute is an entry point.

public abstract void setFilter (WebFilter filter)

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