public interface

WebProjectSettings

com.microstrategy.web.objects.WebProjectSettings
Known Indirect Subclasses

Class Overview

The WebProjectSettings interface represents a collection of settings on a project. The project settings are identified by their ID(from EnumDSSXMLServerProjectSettingID, EnumDSSXMLNotificationDataID or EnumDSSXMLStatisticDataID depending on how the WebProjectSettings are obtained) . The WebProjectSetting objects contained in this collection can be used to examine or change project settings. None of these changes will be persisted to metadata until the WebServerDef object that this object was obtained from is saved.

Summary

Public Methods
abstract boolean contains(int id)
Returns whether an item with the given ID exists in the collection.
abstract Enumeration elements()
Returns a java.util.Enumeration containing the items in the collection.
abstract WebProjectSetting get(int i)
Returns the setting at the given index in the collection.
abstract WebProjectSetting getItemByID(int id)
Returns the setting with the given id in the collection.
abstract int size()
Returns the number of settings in the collection.

Public Methods

public abstract boolean contains (int id)

Returns whether an item with the given ID exists in the collection.

Parameters
id The ID of the item to search for, from EnumDSSXMLServerProjectSettingID, EnumDSSXMLNotificationDataID or EnumDSSXMLStatisticDataID.
Returns
  • True if the ID exists in the collection, false if not.

public abstract Enumeration elements ()

Returns a java.util.Enumeration containing the items in the collection.

Returns
  • A java.util.Enumeration containing the items in the collection.

public abstract WebProjectSetting get (int i)

Returns the setting at the given index in the collection. Note that the items in the collection are not ordered in any way.

Parameters
i The index of the object to return.
Returns

public abstract WebProjectSetting getItemByID (int id)

Returns the setting with the given id in the collection. The ID comes from the EnumDSSXMLServerProjectSettingID, EnumDSSXMLNotificationDataID or EnumDSSXMLStatisticDataID depending on how the WebProjectSettings are obtained collection.

Parameters
id The ID of the item to return from the collection.
Returns
Throws
IllegalArgumentException Thrown if no item with the given ID exists in the collection.

public abstract int size ()

Returns the number of settings in the collection.

Returns
  • The number of settings in the collection.