Summary: Methods | Inherited Methods | [Expand All]

public interface

WebPropertySet

implements WebObjectInfo

com.microstrategy.web.objects.WebPropertySet

Class Overview

WebPropertySet represents a property set, which is a first class object. It is a collection of several WebProperty. This interface provides methods to retrieve the property information about this property set, also provides methods to retrieve a WebProperty in its collection.

Summary

Public Methods
abstract Enumeration	elements() Return an Enumeration of `WebProperty` objects inside this object.
abstract WebProperty	findItemByID(int id) Return the `WebProperty` object according to the ID.
abstract WebProperty	findItemByName(String name) Return the `WebProperty` object, according to the name.
abstract WebProperty	get(int index) Return the `WebProperty` object according to the index.
abstract WebProperty	getItemByID(int id) Return the `WebProperty` object according to the ID.
abstract WebProperty	getItemByName(String name) Return the `WebProperty` object, according to the name.
abstract boolean	hasItemByName(String propertyName)
abstract boolean	isDirty() Return true if any property of this WebPropertySet has been changed, or if any child child `WebProperty` has been changed.
abstract boolean	isEmpty() Return true if there is `WebProperty` object inside this object, else return false.
abstract void	save() Save the current WebPorpertySet information back to MetaData.
abstract int	size() Return the number of `WebProperty` objects inside this object.

[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 Enumeration elements ()

Return an Enumeration of WebProperty objects inside this object.

Returns

An Enumeration representation child WebProperty objects.

public abstract WebProperty findItemByID (int id)

Return the WebProperty object according to the ID. Null is returned if object does not exist.

Parameters

id	an ID corresponding to the "pri" attribute of "properties" node.

Returns

The WebProperty object whose ID, "pri" attribute, matches input parameter id.

public abstract WebProperty findItemByName (String name)

Return the WebProperty object, according to the name. Null is returned if object does not exist.

Parameters

name	The name of the property, which corresponds to the attribute "n".

Returns

The WebProperty object whose name, "n" attribute, matches input parameter name.

public abstract WebProperty get (int index)

Return the WebProperty object according to the index.

Parameters

index	0-based index

Returns

The WebProperty object according to the index

Throws

IndexOutOfBoundsException	If the index is less than 0 or greater than the size, an exception of IndexOutOfBoundsException will be thrown.

public abstract WebProperty getItemByID (int id)

Return the WebProperty object according to the ID.

Parameters

id	an ID corresponding to the "pri" attribute of "properties" node.

Returns

The WebProperty object whose ID, "pri" attribute, matches input parameter id.

Throws

IllegalArgumentException	If there is no matching WebProperty object, an exception of IllegalArgumentException will be thrown.

public abstract WebProperty getItemByName (String name)

Return the WebProperty object, according to the name.

Parameters

name	The name of the property, which corresponds to the attribute "n".

Returns

The WebProperty object whose name, "n" attribute, matches input parameter name.

Throws

IllegalArgumentException	If there is no matching WebProperty object, an exception of IllegalArgumentException will be thrown.

public abstract boolean hasItemByName (String propertyName)

public abstract boolean isDirty ()

Return true if any property of this WebPropertySet has been changed, or if any child child WebProperty has been changed.

Returns

Ture if any property of this WebPropertySet object has been changed, or if any WebProperty object in this collection has been changed. Else, return false.

public abstract boolean isEmpty ()

Return true if there is WebProperty object inside this object, else return false.

Returns

True if there is WebProperty object inside this object, else return false.

public abstract void save ()

Save the current WebPorpertySet information back to MetaData. If there is no change since initialize or last time saving, there will be no request back to MetaData.

Throws

WebObjectsException	If there is anything wrong during the saving progress, an exception of WebObjectsException will be thrown.

public abstract int size ()

Return the number of WebProperty objects inside this object.

Returns

The number of WebProperty objects inside this object.

Interfaces

Classes

Enums

Exceptions

WebPropertySet

Class Overview

Summary

Public Methods

public abstract Enumeration elements ()

Returns

public abstract WebProperty findItemByID (int id)

Parameters

Returns

public abstract WebProperty findItemByName (String name)

Parameters

Returns

public abstract WebProperty get (int index)

Parameters

Returns

Throws

public abstract WebProperty getItemByID (int id)

Parameters

Returns

Throws

public abstract WebProperty getItemByName (String name)

Parameters

Returns

Throws

public abstract boolean hasItemByName (String propertyName)

public abstract boolean isDirty ()

Returns

public abstract boolean isEmpty ()

Returns

public abstract void save ()

Throws

public abstract int size ()

Returns