com.businessobjects.sdk.plugin.desktop.category
Interface ICategories

All Superinterfaces:

java.util.Collection, IInfoObjects, java.lang.Iterable, java.util.List

public interface ICategories
extends IInfoObjects

This interface defines a collection of ICategory objects and is based on the functionality of IInfoObjects. ICategories can add or retrieve ICategory objects in an ICategory collection.

Nested Class Summary

Nested classes/interfaces inherited from interface com.crystaldecisions.sdk.occa.infostore.IInfoObjects

IInfoObjects.CopyModes

Method Summary

ICategory	add() Creates a new ICategory object and adds it to the ICategories collection.
ICategory	getCategory(int index) Gets the element at the specified position in this list.

Methods inherited from interface com.crystaldecisions.sdk.occa.infostore.IInfoObjects

add, add, copy, delete, getBatchSecurityItems, getResultSize, merge, setCommitLevel, update

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

add

ICategory add()
              throws SDKException

Creates a new ICategory object and adds it to the ICategories collection.

Returns:

The newly created ICategory object.

Throws:

SDKException - This exception is thrown if the process is unsuccessful.

getCategory

ICategory getCategory(int index)

Gets the element at the specified position in this list.

Parameters:

index - Takes the index of the element to return as an int.

Returns:

The element (at the specified position in this list) as an ICategory object.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thrown if the index is out of range (index < 0 || index >= size()).