Interface Categories
-
- All Known Implementing Classes:
AbstractCategories
public interface Categories
The Categories interface represents a collection ofCategory
objects.- Since:
- MicroStrategy Web 7.5.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Enumeration
elements()
Returns a java.util.Enumeration object which contains all the objects in this collection.Category
get(int index)
Returns theCategory
at the given index.Category
getItemByName(java.lang.String name)
Searches the collection for aCategory
with the given name, and returns it.boolean
isEmpty()
Returns whether the collection is empty.int
size()
Returns the current size of the Categories collection.
-
-
-
Method Detail
-
get
Category get(int index) throws java.lang.IndexOutOfBoundsException
Returns theCategory
at the given index.- Parameters:
index
- The 0-based index of the item to retrieve.- Returns:
- A
Category
object at the given index. - Throws:
java.lang.IndexOutOfBoundsException
- Thrown if no object with the given index exists.
-
size
int size()
Returns the current size of the Categories collection.- Returns:
- The number of items in the collection.
-
getItemByName
Category getItemByName(java.lang.String name) throws java.lang.IllegalArgumentException
Searches the collection for aCategory
with the given name, and returns it.- Parameters:
name
- The name of the Category to find.- Returns:
- The specified
Category
object. - Throws:
java.lang.IllegalArgumentException
- Thrown if no Category with the given name exists in the collection.
-
isEmpty
boolean isEmpty()
Returns whether the collection is empty.- Returns:
- True if the collection is empty, false otherwise.
-
elements
java.util.Enumeration elements()
Returns a java.util.Enumeration object which contains all the objects in this collection.- Returns:
- An enumeration object with the objects in this collection.
-
-