com.essbase.api.base

Interface IEssExtendedObject

All Superinterfaces:

IEssBaseObject

All Known Subinterfaces:

IEssCalcList, IEssCluster, IEssConnectionPool, IEssCube, IEssCubeOutline, IEssCubeView, IEssCustomObject, IEssCustomObjectDefinition, IEssDimension, IEssDomain, IEssEnterpriseServer, IEssGroup, IEssMember, IEssMemberSelection, IEssMemberWithIndepMbrsSet, IEssOlapApplication, IEssOlapGroup, IEssOlapLicenseInfo, IEssOlapServer, IEssOlapUser, IEssPartition, IEssReferenceCubeInfo, IEssSmartList, IEssUser

public interface IEssExtendedObject
extends IEssBaseObject

The IEssExtendedObject interface.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Method Summary

Modifier and Type	Method and Description
void	clearClientCache() Deprecated. This functionality has been deprecated.
java.lang.String	getName() Gets the name of the object.
IEssExtendedObject	getParent() Gets the parent of the object.
IEssBaseObject	getParentBase() Gets the parent of the object as IEssBaseObject.
boolean	isClientCachingEnabled() Deprecated. This functionality has been deprecated.
void	setClientCachingEnabled(boolean enableCaching) Deprecated. This functionality has been deprecated.

Method Detail

getName

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

Gets the name of the object.

Returns:

The name of the object.

Throws:

EssException - if an error occurs.

getParent

IEssExtendedObject getParent()
                      throws com.essbase.api.base.EssException

Gets the parent of the object.

Returns:

The parent of the object.

Throws:

EssException - if an error occurs.

getParentBase

IEssBaseObject getParentBase()
                      throws com.essbase.api.base.EssException

Gets the parent of the object as IEssBaseObject.

Returns:

The parent of the object as IEssBaseObject.

Throws:

EssException - if an error occurs.

isClientCachingEnabled

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

Deprecated. This functionality has been deprecated.

Checks if client side caching is enabled for this object.

Returns:

true if client caching is enabled.

Throws:

EssException - if an error occurs.

setClientCachingEnabled

void setClientCachingEnabled(boolean enableCaching)
                      throws com.essbase.api.base.EssException

Deprecated. This functionality has been deprecated.

Sets if client side caching is enabled for this object.

Parameters:

enableCaching - true if client caching is to be enabled.

Throws:

EssException - if an error occurs.

clearClientCache

void clearClientCache()
               throws com.essbase.api.base.EssException

Deprecated. This functionality has been deprecated.

Clears the client cache for this object.

Throws:

EssException - if an error occurs.