com.crystaldecisions.sdk.plugin.desktop.folder
Interface IFolders

All Superinterfaces:

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

public interface IFolders
extends IInfoObjects

This interface defines a collection that contains IFolder objects and it is based on the functionality of the IInfoObjects interface. IFolders can retrieve IFolder objects..

See Also:

IInfoObjects

Nested Class Summary

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

IInfoObjects.CopyModes

Method Summary

IFolder	add() Creates a new IFolder and adds it to the IFolders list.
IFolder	getFolder(int index) Gets the IFolder 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

IFolder add()
            throws SDKException

Creates a new IFolder and adds it to the IFolders list.

Returns:

The newly created IFolder folder object.

Throws:

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

getFolder

IFolder getFolder(int index)

Gets the IFolder element at the specified position in this list.

Parameters:

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

Returns:

The IFolder element at the specified position in this list.

Throws:

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