public interface

WebChannels

com.microstrategy.web.objects.WebChannels

Class Overview

The WebChannels interface represents a collection of channels which are defined on a WebServerDef object. The channels represent communication channels on the server; each channel contains methods to read and write properties of the channel.

Summary

Public Methods
abstract boolean contains(String name)
Returns whether the collection contains a channel with the given name.
abstract Enumeration elements()
Returns a java.util.Enumeration of the items in the collection.
abstract WebChannel get(int i)
Returns the WebChannel object at the given index in the collection.
abstract WebChannel getItemByName(String name)
Returns the channel in the collection with the given name.
abstract int size()
Returns the size of the collection.

Public Methods

public abstract boolean contains (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.

public abstract Enumeration elements ()

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

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

public abstract WebChannel get (int i)

Returns the WebChannel object at the given index in the collection.

Parameters
i The index of the object to return.
Returns

public abstract WebChannel getItemByName (String name)

Returns the channel in the collection with the given name.

Parameters
name The name of the channel to search for.
Returns
Throws
IllegalArgumentException Thrown if the given name does not exist in the collection.

public abstract int size ()

Returns the size of the collection.

Returns
  • The number of WebChannel objects in the collection.