Package com.microstrategy.web.objects

Interface WebProjectSettings

All Known Subinterfaces:

WebProjectSettingsModule

public interface WebProjectSettings

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.

Since:

MicroStrategy Web 7.5.2

Method Summary

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

Method Detail

size

int size()

Returns the number of settings in the collection.

Returns:

The number of settings in the collection.

get

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:

The WebProjectSetting object at the given index.

getItemByID

WebProjectSetting getItemByID(int id)
                       throws java.lang.IllegalArgumentException

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:

The WebProjectSetting object with the given ID.

Throws:

java.lang.IllegalArgumentException - Thrown if no item with the given ID exists in the collection.

elements

java.util.Enumeration elements()

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

Returns:

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

contains

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.