public interface

WebCluster

implements CacheHint
com.microstrategy.web.objects.WebCluster

Class Overview

This is a collection of WebClusterNode interfaces.

Summary

[Expand]
Inherited Fields
From interface com.microstrategy.utils.cache.CacheHint
Public Methods
abstract Enumeration elements()
Returns an enumeration of WebClusterNode interfaces that are in the cluster.
abstract WebClusterNode get(int index)
Returns the node at the specified index.
abstract WebProjectInstances getProjects()
Returns the list of all projects loaded on at least one server in the cluster.
abstract int size()
Returns the number of WebClusterNode in this cluster.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.cache.CacheHint

Public Methods

public abstract Enumeration elements ()

Returns an enumeration of WebClusterNode interfaces that are in the cluster.

Returns

public abstract WebClusterNode get (int index)

Returns the node at the specified index.

Parameters
index The index of the node, where the first element has index=1.
Returns
  • An WebClusterNode if the specified index exists in the cluster, or null if the index is larger than the size of the array.
Throws
WebObjectsException

public abstract WebProjectInstances getProjects ()

Returns the list of all projects loaded on at least one server in the cluster.

Returns
  • WebProjectInstances object which is a collection of all loaded projects in the cluster
Throws
WebObjectsException Thrown if there is an error retrieving the list.

public abstract int size ()

Returns the number of WebClusterNode in this cluster.

Returns
  • Number of nodes in the cluster.