public interface

WebPropertyGroup

com.microstrategy.web.objects.WebPropertyGroup

Class Overview

WebPropertyGroup represents a collection of WebPropertySet objects.

Summary

Public Methods
abstract Enumeration elements()
Returns an Enumeration of the collection of WebPropertySet objects inside the group.
abstract WebPropertySet findItemByID(String dssID)
Returns the WebPropertySet object according to the specified DSSID.
abstract WebPropertySet findItemByName(String propertySetName)
Returns the WebPropertySet object according to the specified name.
abstract WebPropertySet get(int index)
Returns the WebPropertySet object according to the index.
abstract WebPropertySet getItemByID(String dssID)
Returns the WebPropertySet object according to the specified DSSID.
abstract WebPropertySet getItemByName(String propertySetName)
Returns the WebPropertySet object according to the specified name.
abstract boolean hasItemByName(String propertySetName)
abstract boolean isEmpty()
Returns true if the group has no WebPropertySet object, else return false.
abstract int size()
Returns the size of the group, the number of WebPropertySet objects inside the group.

Public Methods

public abstract Enumeration elements ()

Returns an Enumeration of the collection of WebPropertySet objects inside the group.

Returns
  • An Enumeration of the WebPropertySet objects inside the WebPropertyGroup.

public abstract WebPropertySet findItemByID (String dssID)

Returns the WebPropertySet object according to the specified DSSID. Null is returned if object does not exist.

Parameters
dssID The DSSID of the searching propertySet.
Returns

public abstract WebPropertySet findItemByName (String propertySetName)

Returns the WebPropertySet object according to the specified name. Null is returned if object does not exist.

Parameters
propertySetName the name of the searching propertySet
Returns

public abstract WebPropertySet get (int index)

Returns the WebPropertySet object according to the index.

Parameters
index the 0-based index
Returns
Throws
IndexOutOfBoundsException If the index is less than 0 or greater than the size of the group, an exception of IndexOutOfBoundsException will be thrown.

public abstract WebPropertySet getItemByID (String dssID)

Returns the WebPropertySet object according to the specified DSSID.

Parameters
dssID The DSSID of the searching propertySet.
Returns
Throws
IllegalArgumentException If there is no propertySet in this propertyGroup whose name is the same as the input parameter, an exception of IllegalArgumentException will be thrown.

public abstract WebPropertySet getItemByName (String propertySetName)

Returns the WebPropertySet object according to the specified name.

Parameters
propertySetName the name of the searching propertySet
Returns
Throws
IllegalArgumentException If there is no propertySet in this propertyGroup whose name is the same as the input parameter, an exception of IllegalArgumentException will be thrown.

public abstract boolean hasItemByName (String propertySetName)

public abstract boolean isEmpty ()

Returns true if the group has no WebPropertySet object, else return false.

Returns
  • True if the WebPropertyGroup has no WebPropertySet object, else false.

public abstract int size ()

Returns the size of the group, the number of WebPropertySet objects inside the group.

Returns
  • The size of this WebPropertyGroup.