com.essbase.api.base
Interface IEssIterator

All Superinterfaces:
IEssBaseObject

public interface IEssIterator
extends IEssBaseObject

The IEssIterator interface.


Method Summary
 IEssBaseObject[] getAll()
          Gets all the objects.
 IEssBaseObject getAt(int index)
          Gets an object at the specified index.
 int getCount()
          Gets the count of objects to iteration.
 

Method Detail

getCount

public int getCount()
             throws EssException
Gets the count of objects to iteration.

Returns:
The count of objects to iterate.
Throws:
EssException - if an error occurs.

getAt

public IEssBaseObject getAt(int index)
                     throws EssException
Gets an object at the specified index.

Parameters:
index - The index.
Returns:
The object.
Throws:
EssException - if an error occurs.

getAll

public IEssBaseObject[] getAll()
                        throws EssException
Gets all the objects.

Returns:
The objects.
Throws:
EssException - if an error occurs.