public interface IEssProperties extends IEssBaseObject
Modifier and Type | Interface and Description |
---|---|
static class |
IEssProperties.EEssPropertyMode
The EEssPropertyMode is an enumeration of property modes.
|
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.
|
int getCountProperties() throws com.essbase.api.base.EssException
EssException
- if an error occurs.java.lang.String[] getPropertyNames() throws com.essbase.api.base.EssException
EssException
- if an error occurs.IEssValueAny.EEssDataType[] getPropertyDataTypes() throws com.essbase.api.base.EssException
EssException
- if an error occurs.IEssProperties.EEssPropertyMode[] getPropertyModes() throws com.essbase.api.base.EssException
EssException
- if an error occurs.int getPropertyId(java.lang.String propName) throws com.essbase.api.base.EssException
propName
- The property name.EssException
- if an error occurs.java.lang.String getPropertyName(int propId) throws com.essbase.api.base.EssException
propId
- The property id.EssException
- if an error occurs.IEssProperties.EEssPropertyMode getPropertyMode(int propId) throws com.essbase.api.base.EssException
propId
- The property id.EssException
- if an error occurs.IEssProperties.EEssPropertyMode getPropertyMode(java.lang.String propName) throws com.essbase.api.base.EssException
propName
- The property name.EssException
- if an error occurs.IEssValueAny.EEssDataType getPropertyDataType(int propId) throws com.essbase.api.base.EssException
propId
- The property id.EssException
- if an error occurs.IEssValueAny.EEssDataType getPropertyDataType(java.lang.String propName) throws com.essbase.api.base.EssException
propName
- The property name.EssException
- if an error occurs.void setPropertyValueAny(java.lang.String propName, IEssValueAny value) throws com.essbase.api.base.EssException
propName
- The property name.value
- The property value.EssException
- if an error occurs.void setPropertyValueAny(int propId, IEssValueAny value) throws com.essbase.api.base.EssException
propId
- The property id.value
- The property value.EssException
- if an error occurs.IEssValueAny getPropertyValueAny(java.lang.String propName) throws com.essbase.api.base.EssException
propName
- The property name.EssException
- if an error occurs.IEssValueAny getPropertyValueAny(int propId) throws com.essbase.api.base.EssException
propId
- The property id.EssException
- if an error occurs.void refreshPropertyValues() throws com.essbase.api.base.EssException
EssException
- if an error occurs.void updatePropertyValues() throws com.essbase.api.base.EssException
EssException
- if an error occurs.