public interface

WebAttribute

implements WebObjectInfo
com.microstrategy.web.objects.WebAttribute

Class Overview

The WebAttribute interface represents an attribute, which is a first class object. This interface allows retrieval of the forms of an attribute.

Summary

Public Methods
abstract WebAttributeForms getBrowseForms()
Returns a list of browse forms which belong to this attribute.
abstract WebDimensionAttribute getDimensionAttribute()
Returns the WebDimensionAttribute which is associated with this attribute.
abstract WebElementSource getElementSource()
Returns an element source which can be used to modify the parameters for element retrieval if this attribute is highlighted.
abstract WebAttributeForms getForms(int webDisplayFormType)
Returns the list of attribute forms based on the display form type which belong to this attribute.
abstract WebAttributeForms getForms()
Returns the list of attribute forms which belong to this attribute.
abstract WebAttributeForms getTemplateForms()
Returns a list of template forms which belong to this attribute.
abstract boolean isProjectAttribute()
Returns whether this attribute is a project attribute.
abstract boolean requiresLookupTable()
Returns whether this attribute requires a lookup table in order to obtain elements for it.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract WebAttributeForms getBrowseForms ()

Returns a list of browse forms which belong to this attribute. Browse forms are those forms which will be used by default when browsing elements of the attribute.

Returns

public abstract WebDimensionAttribute getDimensionAttribute ()

Returns the WebDimensionAttribute which is associated with this attribute. Note that every attribute belongs to a dimension; if the attribute did not come from a dimension object, then the attribute is presumed to come from the system dimension.

Returns
Throws
WebObjectsException Thrown if the dimension attribute cannot be determined.

public abstract WebElementSource getElementSource ()

Returns an element source which can be used to modify the parameters for element retrieval if this attribute is highlighted.

Returns
  • A WebElementSource object, which can be used to control element browsing in the event that this attribute is detailed/highlighted.

public abstract WebAttributeForms getForms (int webDisplayFormType)

Returns the list of attribute forms based on the display form type which belong to this attribute.

Parameters
webDisplayFormType - value from EnumWebDisplayedForms.
Returns

public abstract WebAttributeForms getForms ()

Returns the list of attribute forms which belong to this attribute.

Returns

public abstract WebAttributeForms getTemplateForms ()

Returns a list of template forms which belong to this attribute. Template forms are those forms which will be used by default when the attribute appears inside a report.

Returns
  • A WebAttributeForms collection, containing only the template forms of the attribute.

public abstract boolean isProjectAttribute ()

Returns whether this attribute is a project attribute.

Returns
  • False if the attribute comes from a MDX Cube and "ipa" attribute is not set, true otherwise.

public abstract boolean requiresLookupTable ()

Returns whether this attribute requires a lookup table in order to obtain elements for it. If this is true, then the attribute's elements cannot be browsed using the GetElements call without additional context information.

Returns
  • True if the attribute cannot be browsed, false otherwise.