Package com.microstrategy.web.objects
Interface WebCluster
-
- All Superinterfaces:
CacheHint
public interface WebCluster extends CacheHint
This is a collection ofWebClusterNode
interfaces.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.cache.CacheHint
ZERO_STATE_ID
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Enumeration
elements()
Returns an enumeration ofWebClusterNode
interfaces that are in the cluster.WebClusterNode
get(int index)
Returns the node at the specified index.WebProjectInstances
getProjects()
Returns the list of all projects loaded on at least one server in the cluster.int
size()
Returns the number ofWebClusterNode
in this cluster.-
Methods inherited from interface com.microstrategy.utils.cache.CacheHint
getCacheStateId, setCacheStateId
-
-
-
-
Method Detail
-
elements
java.util.Enumeration elements()
Returns an enumeration ofWebClusterNode
interfaces that are in the cluster.- Returns:
- An Enumeration containing all of the
WebClusterNode
in the cluster.
-
size
int size()
Returns the number ofWebClusterNode
in this cluster.- Returns:
- Number of nodes in the cluster.
-
get
WebClusterNode get(int index) throws WebObjectsException
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
-
getProjects
WebProjectInstances getProjects() throws WebObjectsException
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.- Since:
- MicroStrategy Web 8.0.0
-
-