Package com.microstrategy.web.objects
Interface WebChannels
-
public interface WebChannels
The WebChannels interface represents a collection of channels which are defined on aWebServerDef
object. The channels represent communication channels on the server; each channel contains methods to read and write properties of the channel.- Since:
- MicroStrategy Web 7.5.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
contains(java.lang.String name)
Returns whether the collection contains a channel with the given name.java.util.Enumeration
elements()
Returns a java.util.Enumeration of the items in the collection.WebChannel
get(int i)
Returns theWebChannel
object at the given index in the collection.WebChannel
getItemByName(java.lang.String name)
Returns the channel in the collection with the given name.int
size()
Returns the size of the collection.
-
-
-
Method Detail
-
get
WebChannel get(int i)
Returns theWebChannel
object at the given index in the collection.- Parameters:
i
- The index of the object to return.- Returns:
- The
WebChannel
object at the given index.
-
size
int size()
Returns the size of the collection.- Returns:
- The number of
WebChannel
objects in the collection.
-
elements
java.util.Enumeration elements()
Returns a java.util.Enumeration of the items in the collection.- Returns:
- A java.util.Enumeration of the items in the collection.
-
getItemByName
WebChannel getItemByName(java.lang.String name) throws java.lang.IllegalArgumentException
Returns the channel in the collection with the given name.- Parameters:
name
- The name of the channel to search for.- Returns:
- The
WebChannel
object with the given name. - Throws:
java.lang.IllegalArgumentException
- Thrown if the given name does not exist in the collection.
-
contains
boolean contains(java.lang.String name)
Returns whether the collection contains a channel with the given name.- Parameters:
name
- The name of the channel to search for.- Returns:
- True if a channel exists with the given name, false otherwise.
-
-