com.essbase.api.dataquery

Interface IEssMemberCell

All Superinterfaces:

IEssBaseObject, IEssCell

public interface IEssMemberCell
extends IEssCell

The IEssMemberCell is a member cell in a cube view.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Nested Class Summary

Nested classes/interfaces inherited from interface com.essbase.api.dataquery.IEssCell

IEssCell.EEssCellType

Method Summary

Modifier and Type	Method and Description
int	getDimensionNumber() Gets the dimension number.
IEssIterator	getLinkedObjects() Gets the linked objects in the cell.
java.lang.String	getMemberKey() Gets the member key that corresponds to the cell if the cell type is EEssCellType.MEMBERwKEY, otherwise returns null.
java.lang.String	getMemberName() Gets the member name that corresponds to the cell.
boolean	isDimensionTop()
boolean	isDrillThrough() Checks if the cell has a drill through report associated with it or not.
boolean	isDynCalc()
boolean	isExpShare()
boolean	isImpShare()
boolean	isLabelOnly()
boolean	isNeverShare()
boolean	isNonUnique()
boolean	isStoreData()
boolean	isZoominable()

Methods inherited from interface com.essbase.api.dataquery.IEssCell

getCellType, getValue, setValue

Method Detail

getMemberName

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

Gets the member name that corresponds to the cell.

Returns:

The member name.

Throws:

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

getMemberKey

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

Gets the member key that corresponds to the cell if the cell type is EEssCellType.MEMBERwKEY, otherwise returns null.

Returns:

The member key.

Throws:

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

isDimensionTop

boolean isDimensionTop()
                throws com.essbase.api.base.EssException

Returns:

true if dimension is top.

Throws:

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

isZoominable

boolean isZoominable()
              throws com.essbase.api.base.EssException

Returns:

true if zoominable.

Throws:

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

isNeverShare

boolean isNeverShare()
              throws com.essbase.api.base.EssException

Returns:

true is never share is set.

Throws:

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

isLabelOnly

boolean isLabelOnly()
             throws com.essbase.api.base.EssException

Returns:

true if it's label only.

Throws:

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

isStoreData

boolean isStoreData()
             throws com.essbase.api.base.EssException

Returns:

true if it's store data.

Throws:

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

isExpShare

boolean isExpShare()
            throws com.essbase.api.base.EssException

Returns:

true if it's exp share.

Throws:

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

isImpShare

boolean isImpShare()
            throws com.essbase.api.base.EssException

Returns:

true if it's imp share.

Throws:

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

isDynCalc

boolean isDynCalc()
           throws com.essbase.api.base.EssException

Returns:

true if it's dynamic calculation.

Throws:

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

isNonUnique

boolean isNonUnique()
             throws com.essbase.api.base.EssException

Returns:

true if it's not unique.

Throws:

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

getDimensionNumber

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

Gets the dimension number. The number for the first dimension is 1, second is 2, and so on.

Returns:

The dimension number.

Throws:

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

getLinkedObjects

IEssIterator getLinkedObjects()
                       throws com.essbase.api.base.EssException

Gets the linked objects in the cell.

Returns:

The linked objects (each of type IEssLinkedObject).

Throws:

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

isDrillThrough

boolean isDrillThrough()
                throws com.essbase.api.base.EssException

Checks if the cell has a drill through report associated with it or not.

Returns:

true if cell has a drill through report associated with it.

Throws:

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