Interface Categories
-
- All Known Implementing Classes:
AbstractCategories
public interface CategoriesThe Categories interface represents a collection ofCategoryobjects.- Since:
- MicroStrategy Web 7.5.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Enumerationelements()Returns a java.util.Enumeration object which contains all the objects in this collection.Categoryget(int index)Returns theCategoryat the given index.CategorygetItemByName(java.lang.String name)Searches the collection for aCategorywith the given name, and returns it.booleanisEmpty()Returns whether the collection is empty.intsize()Returns the current size of the Categories collection.
-
-
-
Method Detail
-
get
Category get(int index) throws java.lang.IndexOutOfBoundsException
Returns theCategoryat the given index.- Parameters:
index- The 0-based index of the item to retrieve.- Returns:
- A
Categoryobject 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 aCategorywith the given name, and returns it.- Parameters:
name- The name of the Category to find.- Returns:
- The specified
Categoryobject. - 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.
-
-