com.essbase.api.metadata

Interface IEssLevel

All Superinterfaces:

IEssBaseObject

public interface IEssLevel
extends IEssBaseObject

The IEssLevel interface. (FOR FUTURE USE ONLY.)

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActualName() Gets the actual level name.
java.lang.String	getDefaultName() Gets the default level name.
java.lang.String	getName() Gets the level name.
int	getNumber() Gets the level number.
boolean	isUnique() Returns if the Uniqueness at Level is enabled or disabled.

Method Detail

getName

java.lang.String getName()
                  throws com.essbase.api.base.EssException

Gets the level name. If there is an actual name associated, the actual name is returned, else the default name is returned.

Returns:

The level 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 level name.

Returns:

The default level 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 level name.

Returns:

The actual level name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getNumber

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

Gets the level number.

Returns:

The level 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 Level is enabled or disabled.

Returns:

if true, the members at this level cannot have duplicate member names; otherwise false to indicate duplicate member names at this level are allowed.

Throws:

com.essbase.api.base.EssException - if an error occurs.