com.essbase.api.dataquery

Interface IEssMdMember

All Superinterfaces:

IEssBaseObject, IEssProperties

public interface IEssMdMember
extends IEssBaseObject, IEssProperties

The IEssMdMember interface. This represents a member or dimension in the multi-dimensional result set returned by an MDX query operation.

Version:

1.0, 04/09/2004

Author:

Abhijeet Katariya

Nested Class Summary

Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties

IEssProperties.EEssPropertyMode

Method Summary

Modifier and Type	Method and Description
IEssMdMember	getDimension() Gets the dimension to which this member belongs.
IEssIterator	getLinkedObjects() Gets the linked objects associated with the member.
java.lang.String	getName() Returns this member's (or dimension's id it represents a dimension) identifier.
boolean	isCalced() Checks if this member is a calculated member
boolean	isDimension() Checks if this member represents a dimension.
boolean	isDrillThrough() Checks if this member has a drill through associated with it.

Methods inherited from interface com.essbase.api.base.IEssProperties

getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, refreshPropertyValues, setPropertyValueAny, setPropertyValueAny, updatePropertyValues

Method Detail

getName

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

Returns this member's (or dimension's id it represents a dimension) identifier. The return value is either the member (or dimension) name or alias name based on what option was passed in IEssOpMdxQuery for member identifier type.

Returns:

The MDX member name or alias.

Throws:

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

isDimension

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

Checks if this member represents a dimension.

Returns:

True if the member is a dimension, false otherwise.

Throws:

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

getDimension

IEssMdMember getDimension()
                   throws com.essbase.api.base.EssException

Gets the dimension to which this member belongs.

Returns:

IEssMdMember instance for the dimension.

Throws:

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

isCalced

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

Checks if this member is a calculated member

Returns:

True if the member is a calculated member, false otherwise.

Throws:

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

isDrillThrough

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

Checks if this member has a drill through associated with it.

Returns:

True if the member has a drill through associated with it, false otherwise.

Throws:

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

getLinkedObjects

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

Gets the linked objects associated with the member. Use this method to get drill through reports associated with the member.

Returns:

The linked objects (each of type IEssLinkedObject).

Throws:

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