Summary: Methods | Inherited Methods | [Expand All]

public interface

WebDimension

implements WebObjectInfo

com.microstrategy.web.objects.WebDimension

Class Overview

This interface represents a dimension, which is a first class object. The WebDimension interface is primarily a collection of attributes, and most of its' methods which are not derived from WebObjectInfo reflect that fact.

Summary

Public Methods
abstract Enumeration	elements() Returns a java.util.Enumeration containing the attributes within the collection.
abstract WebDimensionAttribute	get(int index) Returns the attribute within the collection with the given index.
abstract int	getStyle() Returns the XML style in which the dimension will be output in display XML.
abstract WebDisplayUnits	getTopLevelAttributes()
abstract boolean	isEmpty() Returns whether the dimension has any attributes.
abstract WebDimensionAttribute	itemByID(String attributeDSSID) Searches for an attribute with the given DSSID in the WebDimension collection.
abstract void	setStyle(int style) Sets the XML style will be used when generating display XML for this dimension.
abstract int	size() Returns the number of attributes in the dimension collection.

[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 WebCertifiedInfo	getCertifiedInfo()
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 long	getCreationTimeStamp() Get the object creation timestamp in millisecond.
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() Get the object modification timestamp in millisecond.
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	getPreSaveAsFlags() Returns the flags which determine the previous save as prompt flag.
abstract String	getProjectId()
abstract String	getProjectName()
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 WebRecommendationInfo	getRecommendationInfo() This contains all the information related to a recommendation search
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(String xml) Populates the fields on this object by loading the given object definition XML.
abstract void	populate() Populates the fields on this object by asking the Intelligence Server for the object definition.
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	setPreSaveAsFlags(int flags) Sets the flags which determine the previous save as prompt flag.
abstract void	setPropertyFlags(int flags) Set the current property flags

From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract Enumeration elements ()

Returns a java.util.Enumeration containing the attributes within the collection.

Returns

An Enumeration containing the objects within the dimension.

public abstract WebDimensionAttribute get (int index)

Returns the attribute within the collection with the given index.

Parameters

index	The index of the object to find.

Returns

The WebDimensionAttribute object corresponding to the given index.

Throws

IndexOutOfBoundsException	Thrown if the given index is invalid.

public abstract int getStyle ()

Returns the XML style in which the dimension will be output in display XML.

Returns

The current display style of the dimension, from EnumWebDimensionDisplayStyle.

public abstract WebDisplayUnits getTopLevelAttributes ()

public abstract boolean isEmpty ()

Returns whether the dimension has any attributes.

Returns

True if the dimension has attributes, false if it does not.

public abstract WebDimensionAttribute itemByID (String attributeDSSID)

Searches for an attribute with the given DSSID in the WebDimension collection.

Parameters

attributeDSSID	The DSS ID of the attribute to search for in the dimension.

Returns

The WebDimensionAttribute object with the given DSS ID.

Throws

IllegalArgumentException	Thrown if an attribute by the given DSS ID is not found in the dimension.

public abstract void setStyle (int style)

Sets the XML style will be used when generating display XML for this dimension.

Parameters

style	The display style to use for the dimension, which should be a value from `EnumWebDimensionDisplayStyle`.

public abstract int size ()

Returns the number of attributes in the dimension collection.

Returns

The size of the dimension collection.

Interfaces

Classes

Enums

Exceptions

WebDimension

Class Overview

Summary

Public Methods

public abstract Enumeration elements ()

Returns

public abstract WebDimensionAttribute get (int index)

Parameters

Returns

Throws

public abstract int getStyle ()

Returns

See Also

public abstract WebDisplayUnits getTopLevelAttributes ()

public abstract boolean isEmpty ()

Returns

public abstract WebDimensionAttribute itemByID (String attributeDSSID)

Parameters

Returns

Throws

public abstract void setStyle (int style)

Parameters

See Also

public abstract int size ()

Returns