com.essbase.api.base

Interface IEssIterator

All Superinterfaces:

IEssBaseObject

public interface IEssIterator
extends IEssBaseObject

The IEssIterator interface.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Method Summary

Modifier and Type	Method and Description
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

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

Gets the count of objects to iteration.

Returns:

The count of objects to iterate.

Throws:

EssException - if an error occurs.

getAt

IEssBaseObject getAt(int index)
              throws com.essbase.api.base.EssException

Gets an object at the specified index.

Parameters:

index - The index.

Returns:

The object.

Throws:

EssException - if an error occurs.

getAll

IEssBaseObject[] getAll()
                 throws com.essbase.api.base.EssException

Gets all the objects.

Returns:

The objects.

Throws:

EssException - if an error occurs.