Package com.microstrategy.web.objects
Interface WebClusterProjectInfoCollection
-
public interface WebClusterProjectInfoCollection
Defines generic functionality for a collection ofWebClusterProjectInfo
objects.- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebClusterProjectInfo
get(int index)
Returns the project info object with the given index from the collection.boolean
isEmpty()
Returns true if the collection is empty, false if it contains one or more projects.WebClusterProjectInfo
itemByProject(WebProjectInstance instance)
Returns the project info object for the provided project, if one exists.int
size()
Returns the number of projects within the collection.
-
-
-
Method Detail
-
size
int size()
Returns the number of projects within the collection.- Returns:
- The size of the project collection.
-
isEmpty
boolean isEmpty()
Returns true if the collection is empty, false if it contains one or more projects.- Returns:
- A boolean value indicating whether the collection is empty.
-
get
WebClusterProjectInfo get(int index) throws java.lang.IndexOutOfBoundsException
Returns the project info object with the given index from the collection.- Returns:
- A
WebClusterProjectInfo
object contained at the given index in the collection. - Throws:
java.lang.IndexOutOfBoundsException
- Thrown if the index could not be found in the collection.
-
itemByProject
WebClusterProjectInfo itemByProject(WebProjectInstance instance) throws java.lang.IllegalArgumentException
Returns the project info object for the provided project, if one exists. Returns null otherwise- Parameters:
instance
-WebProjectInstance
associated with the desired info object- Returns:
WebClusterProjectInfo
for provided project- Throws:
java.lang.IllegalArgumentException
-
-