Package com.microstrategy.web.objects
Interface WebServerSettings
-
public interface WebServerSettings
The WebServerSettings interface represents a collection of server settings associated with aWebServerDef
object. The settings in this collection are distinguished by their ID.- Since:
- MicroStrategy Web 7.5.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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 all the items in the collection.WebServerSetting
get(int i)
Returns the item at the given index in the collection.WebServerSetting
getItemByID(int id)
Returns the item with the given ID in the collection.int
size()
This method returns the number of settings in the collection.
-
-
-
Method Detail
-
size
int size()
This method returns the number of settings in the collection.- Returns:
- The size of the collection.
-
get
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:
- The
WebServerSetting
object at the given index.
-
getItemByID
WebServerSetting getItemByID(int id) throws java.lang.IllegalArgumentException
Returns the item with the given ID in the collection.- Parameters:
id
- The ID of the setting to return, fromEnumDSSXMLServerSettingID
.- Returns:
- The
WebServerSetting
object with the given ID. - Throws:
java.lang.IllegalArgumentException
- Thrown if no item with the given ID is found.
-
elements
java.util.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.
-
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, fromEnumDSSXMLServerSettingID
.- Returns:
- True if the item exists in the collection, false otherwise.
-
-