com.essbase.api.metadata
Interface IEssGeneration

All Superinterfaces:
IEssBaseObject

public interface IEssGeneration
extends IEssBaseObject

The IEssGeneration interface. (FOR FUTURE USE ONLY.)


Method Summary
 java.lang.String getActualName()
          Gets the actual generation name.
 java.lang.String getDefaultName()
          Gets the default generation name.
 java.lang.String getName()
          Gets the generation name.
 int getNumber()
          Gets the generation number.
 

Method Detail

getName

public java.lang.String getName()
                         throws EssException
Gets the generation name. If there is an actual name associated, the actual name is returned, else the default name is returned.

Returns:
The generation name.
Throws:
EssException - if an error occurs.

getDefaultName

public java.lang.String getDefaultName()
                                throws EssException
Gets the default generation name.

Returns:
The default generation name.
Throws:
EssException - if an error occurs.

getActualName

public java.lang.String getActualName()
                               throws EssException
Gets the actual generation name.

Returns:
The actual generation name. "" if there is no actual name.
Throws:
EssException - if an error occurs.

getNumber

public int getNumber()
              throws EssException
Gets the generation number.

Returns:
The generation number.
Throws:
EssException - if an error occurs.