public interface

WebServerSettings

com.microstrategy.web.objects.WebServerSettings

Class Overview

The WebServerSettings interface represents a collection of server settings associated with a WebServerDef object. The settings in this collection are distinguished by their ID.

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 all the items in the collection.
abstract WebServerSetting get(int i)
Returns the item at the given index in the collection.
abstract WebServerSetting getItemByID(int id)
Returns the item with the given ID in the collection.
abstract int size()
This method 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 EnumDSSXMLServerSettingID.
Returns
  • True if the item exists in the collection, false otherwise.

public abstract Enumeration elements ()

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

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

public abstract WebServerSetting get (int i)

Returns the item at the given index in the collection.

Parameters
i The index of the item to return in the collection.
Returns

public abstract WebServerSetting getItemByID (int id)

Returns the item with the given ID in the collection.

Parameters
id The ID of the setting to return, from EnumDSSXMLServerSettingID.
Returns
Throws
IllegalArgumentException Thrown if no item with the given ID is found.

public abstract int size ()

This method returns the number of settings in the collection.

Returns
  • The size of the collection.