com.essbase.api.base

Interface IEssProperties

All Superinterfaces:

IEssBaseObject

All Known Subinterfaces:

IEssCluster, IEssConnectionPool, IEssCube, IEssCubeOutline, IEssCubeView, IEssDimension, IEssDomain, IEssEnterpriseServer, IEssGroup, IEssMdMember, IEssMember, IEssMemberSelection, IEssMemberWithIndepMbrsSet, IEssOlapApplication, IEssOlapGroup, IEssOlapLicenseInfo, IEssOlapServer, IEssOlapUser, IEssUser

public interface IEssProperties
extends IEssBaseObject

The IEssProperties interface.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IEssProperties.EEssPropertyMode The EEssPropertyMode is an enumeration of property modes.

Method Summary

Modifier and Type	Method and Description
int	getCountProperties() Gets the count of properties.
IEssValueAny.EEssDataType	getPropertyDataType(int propId) Gets the property datatype for the specified id.
IEssValueAny.EEssDataType	getPropertyDataType(java.lang.String propName) Gets the property datatype for the specified name.
IEssValueAny.EEssDataType[]	getPropertyDataTypes() Gets the list of property data types.
int	getPropertyId(java.lang.String propName) Gets the property id for the specified name.
IEssProperties.EEssPropertyMode	getPropertyMode(int propId) Gets the property mode for the specified id.
IEssProperties.EEssPropertyMode	getPropertyMode(java.lang.String propName) Gets the property mode for the specified name.
IEssProperties.EEssPropertyMode[]	getPropertyModes() Gets the list of property modes.
java.lang.String	getPropertyName(int propId) Gets the property name for the specified id.
java.lang.String[]	getPropertyNames() Gets the list of property names.
IEssValueAny	getPropertyValueAny(int propId) Gets the property value for the specified id.
IEssValueAny	getPropertyValueAny(java.lang.String propName) Gets the property value for the specified name.
void	refreshPropertyValues() Refreshes the property values.
void	setPropertyValueAny(int propId, IEssValueAny value) Sets the property value for the specified id.
void	setPropertyValueAny(java.lang.String propName, IEssValueAny value) Sets the property value for the specified name.
void	updatePropertyValues() Updates the property values.

Method Detail

getCountProperties

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

Gets the count of properties.

Returns:

The count of properties.

Throws:

EssException - if an error occurs.

getPropertyNames

java.lang.String[] getPropertyNames()
                             throws com.essbase.api.base.EssException

Gets the list of property names.

Returns:

The list of property names.

Throws:

EssException - if an error occurs.

getPropertyDataTypes

IEssValueAny.EEssDataType[] getPropertyDataTypes()
                                          throws com.essbase.api.base.EssException

Gets the list of property data types.

Returns:

The list of property data types.

Throws:

EssException - if an error occurs.

getPropertyModes

IEssProperties.EEssPropertyMode[] getPropertyModes()
                                            throws com.essbase.api.base.EssException

Gets the list of property modes.

Returns:

The list of property modes.

Throws:

EssException - if an error occurs.

getPropertyId

int getPropertyId(java.lang.String propName)
           throws com.essbase.api.base.EssException

Gets the property id for the specified name.

Parameters:

propName - The property name.

Returns:

The property id.

Throws:

EssException - if an error occurs.

getPropertyName

java.lang.String getPropertyName(int propId)
                          throws com.essbase.api.base.EssException

Gets the property name for the specified id.

Parameters:

propId - The property id.

Returns:

The property name.

Throws:

EssException - if an error occurs.

getPropertyMode

IEssProperties.EEssPropertyMode getPropertyMode(int propId)
                                         throws com.essbase.api.base.EssException

Gets the property mode for the specified id.

Parameters:

propId - The property id.

Returns:

The property mode.

Throws:

EssException - if an error occurs.

getPropertyMode

IEssProperties.EEssPropertyMode getPropertyMode(java.lang.String propName)
                                         throws com.essbase.api.base.EssException

Gets the property mode for the specified name.

Parameters:

propName - The property name.

Returns:

The property mode.

Throws:

EssException - if an error occurs.

getPropertyDataType

IEssValueAny.EEssDataType getPropertyDataType(int propId)
                                       throws com.essbase.api.base.EssException

Gets the property datatype for the specified id.

Parameters:

propId - The property id.

Returns:

The property data type.

Throws:

EssException - if an error occurs.

getPropertyDataType

IEssValueAny.EEssDataType getPropertyDataType(java.lang.String propName)
                                       throws com.essbase.api.base.EssException

Gets the property datatype for the specified name.

Parameters:

propName - The property name.

Returns:

The property data type.

Throws:

EssException - if an error occurs.

setPropertyValueAny

void setPropertyValueAny(java.lang.String propName,
                         IEssValueAny value)
                  throws com.essbase.api.base.EssException

Sets the property value for the specified name.

Parameters:

propName - The property name.

value - The property value.

Throws:

EssException - if an error occurs.

setPropertyValueAny

void setPropertyValueAny(int propId,
                         IEssValueAny value)
                  throws com.essbase.api.base.EssException

Sets the property value for the specified id.

Parameters:

propId - The property id.

value - The property value.

Throws:

EssException - if an error occurs.

getPropertyValueAny

IEssValueAny getPropertyValueAny(java.lang.String propName)
                          throws com.essbase.api.base.EssException

Gets the property value for the specified name.

Parameters:

propName - The property name.

Returns:

The property value.

Throws:

EssException - if an error occurs.

getPropertyValueAny

IEssValueAny getPropertyValueAny(int propId)
                          throws com.essbase.api.base.EssException

Gets the property value for the specified id.

Parameters:

propId - The property id.

Returns:

The property value.

Throws:

EssException - if an error occurs.

refreshPropertyValues

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

Refreshes the property values. The JAPI cache for this object is refreshed with the latest values from the server, so that all the getXXX() methods will return the latest values.

Throws:

EssException - if an error occurs.

updatePropertyValues

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

Updates the property values. The changes made to this object via setXXX() methods will become effective only after you invoke updatePropertyValues().

Throws:

EssException - if an error occurs.