Summary: Methods | Inherited Methods | [Expand All]

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

abstract void	addDetails(boolean details) This method will add or remove details from the display unit.
abstract void	applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
abstract boolean	canHighlight()
abstract WebDisplayUnits	getChildUnits() Returns the collection of child display units, or null if the object is not a collection.
abstract String	getDisplayName() Returns the display name associated with this object.
abstract int	getDisplayUnitType() Returns the type of display unit that this object represents.
abstract String	getID() Returns the DSS ID of the display unit.
abstract boolean	hasDetails() Returns whether this display unit currently has details enabled.
abstract void	highlightUnit() Sets this display unit to be highlighted.
abstract void	highlightUnit(boolean details) Sets this display unit to be highlighted.
abstract boolean	isHighlighted() Returns whether this unit is highlighted.
abstract boolean	isObjectInfo() Returns true if underlying Web Object can be cast to `WebObjectInfo`.
abstract boolean	isSelected() Returns whether this display unit is selected.
abstract void	setDisplayName(String displayName) This method will set the value of the display name.
abstract void	setSelected(boolean selected) Sets the current unit's selection status.

From interface com.microstrategy.web.objects.WebFeatures

From interface com.microstrategy.web.objects.WebObjectInfo

abstract void	buildShortObjectAttributes(WebXMLBuilder builder)
abstract void	buildShortXML(WebXMLBuilder builder)
abstract String	getAbbreviation() Returns the abbreviation of this object.
abstract int	getAccessGranted() Returns the current access granted on this object, if available.
abstract SimpleList	getAncestors() Returns a `SimpleList` containing the ancestors of this object, if they exist in the object XML.
abstract String[]	getComments() Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
abstract String	getContainerDid()
abstract String	getContainerType()
abstract String	getCreationTime() Returns the creation time of this object, if that information is available.
abstract String	getDataSources()
abstract String	getDescription() Returns the description of the object.
abstract int	getExtendedType() The current extended type
abstract WebObjectsFactory	getFactory() Returns WebObjectsFactory
abstract int	getFlags() Returns the flags which determine what data to populate upon calling populate.
abstract String	getID() Returns the DSS ID of the object, if one exists.
abstract String	getIconPath() Return the icon path for the object
abstract String	getModificationTime() Returns the last modification time of the object, if that information is available.
abstract long	getModificationTimeStamp()
abstract String	getName() Returns the name of this object.
abstract boolean	getNonSchedulable() Get flag of whether the object is not schedulable
abstract int	getOtherNameTransCount() Returns the count of name translations for locales other than the current effective locale.
abstract WebObjectInfo	getOwner() Returns a WebObjectInfo object which corresponds to the owner of this object.
abstract WebFolder	getParent() Returns the parent folder of the current object, if it exists.
abstract int	getPropertyFlags() Retrieve the current property flags
abstract SimpleList	getPropertySetFilter() Returns an editable `SimpleList` where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state.
abstract WebPropertyGroup	getPropertySets() Returns the property sets associated with this object.
abstract WebObjectSecurity	getSecurity() Returns the `WebObjectSecurity` object associated with this WebObjectInfo object.
abstract int	getState() Returns the state of the object.
abstract int	getSubType() Returns the subtype of the object.
abstract int	getType() Returns the type of this object.
abstract String	getVersionID() Returns the Version ID of the object, if one exists.
abstract WebViewMediaSettings	getViewMediaSettings()
abstract int	getVisualizationViewMode()
abstract String	getXML(boolean encode) Returns the XML representation of this object.
abstract String	getXML() Returns the XML representation of this object.
abstract boolean	hasOwner()
abstract boolean	isAncestorNamedFolder(int folderName) Returns whether the named folder is this object's ancestor.
abstract boolean	isDirty() Returns whether this object has been modified to be different from the object in metadata.
abstract boolean	isEmbedded()
abstract boolean	isHidden() Returns whether the object is a hidden object.
abstract boolean	isNew() Returns whether this object is newly created at client side, which is not in the metadata.
abstract boolean	isPopulated() Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
abstract void	populate() Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void	populate(String xml) Populates the fields on this object by loading the given object definition XML.
abstract void	setAbbreviation(String abbreviation)
abstract void	setComments(String[] comments) Set the long description of the object as an array of strings.
abstract void	setDataSources(String dataSourcesXML)
abstract void	setDescription(String description) Sets the description of the object.
abstract void	setExtendedType(int extendedType) Set the current extended type
abstract void	setFlags(int flags) Sets the flags which determine what data to populate upon calling populate.
abstract void	setHidden(boolean hidden) Sets whether the object is a hidden object.
abstract void	setIconPath(String iconPath) Set the icon path for the object
abstract void	setName(String _name)
abstract void	setNonSchedulable(boolean nonSchedulable) Set flag of whether the object is not schedulable
abstract void	setPropertyFlags(int flags) Set the current property flags

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

A WebAttributeForms collection, containing only the browse forms of the attribute.

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

The WebDimensionAttribute associated with the attribute.

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

A WebAttributeForms collection, forms of the attribute based on the type.

public abstract WebAttributeForms getForms ()

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

Returns

A WebAttributeForms collection, containing all forms of the attribute.

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.

Interfaces

Classes

Enums

Exceptions

WebAttribute

Class Overview

Summary

Public Methods

public abstract WebAttributeForms getBrowseForms ()

Returns

public abstract WebDimensionAttribute getDimensionAttribute ()

Returns

Throws

public abstract WebElementSource getElementSource ()

Returns

public abstract WebAttributeForms getForms (int webDisplayFormType)

Parameters

Returns

public abstract WebAttributeForms getForms ()

Returns

public abstract WebAttributeForms getTemplateForms ()

Returns

public abstract boolean isProjectAttribute ()

Returns

public abstract boolean requiresLookupTable ()

Returns