Skip navigation links


com.essbase.api.metadata
Interface IEssGeneration

All Superinterfaces:
IEssBaseObject

public interface IEssGeneration
extends IEssBaseObject

The IEssGeneration interface. (FOR FUTURE USE ONLY.)

Version:
1.0, 04/04/2001
Author:
Srini Ranga

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.
 boolean isUnique()
          Returns if the Uniqueness at Generation is enabled or disabled.

 

Method Detail

getName

java.lang.String getName()
                         throws com.essbase.api.base.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:
com.essbase.api.base.EssException - if an error occurs.

getDefaultName

java.lang.String getDefaultName()
                                throws com.essbase.api.base.EssException
Gets the default generation name.
Returns:
The default generation name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getActualName

java.lang.String getActualName()
                               throws com.essbase.api.base.EssException
Gets the actual generation name.
Returns:
The actual generation name. "" if there is no actual name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getNumber

int getNumber()
              throws com.essbase.api.base.EssException
Gets the generation number.
Returns:
The generation number.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isUnique

boolean isUnique()
                 throws com.essbase.api.base.EssException
Returns if the Uniqueness at Generation is enabled or disabled.
Returns:
if true, the members at this generation cannot have duplicate member names; otherwise false to indicate duplicate member names at this gen are allowed.
Throws:
com.essbase.api.base.EssException - if an error occurs.

Skip navigation links