com.essbase.api.base

Interface IEssCollection

All Superinterfaces:

IEssBaseObject

public interface IEssCollection
extends IEssBaseObject

The IEssCollection interface allows to manage a collection of objects.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Method Summary

Modifier and Type	Method and Description
void	add(IEssBaseObject object) Adds an object to the collection.
int	getCount() Gets the count of objects in the collection.
IEssIterator	getIterator() Gets an iterator on the collection.
void	remove(IEssBaseObject object) Removes an object from the collection.

Method Detail

add

void add(IEssBaseObject object)
  throws com.essbase.api.base.EssException

Adds an object to the collection.

Parameters:

object - The object to add.

Throws:

EssException - if an error occurs.

remove

void remove(IEssBaseObject object)
     throws com.essbase.api.base.EssException

Removes an object from the collection.

Parameters:

object - The object to remove.

Throws:

EssException - if an error occurs.

getCount

int getCount()
      throws com.essbase.api.base.EssException

Gets the count of objects in the collection.

Returns:

The count of objects in the collection.

Throws:

EssException - if an error occurs.

getIterator

IEssIterator getIterator()
                  throws com.essbase.api.base.EssException

Gets an iterator on the collection.

Returns:

An iterator on the collection.

Throws:

EssException - if an error occurs.