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
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 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
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