|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEssDimension
The IEssDimension is the dimension.
Nested Class Summary | |
---|---|
static class |
IEssDimension.EEssAttributeDataType EEssAttributeDataType class is the enumeration of attribute member or dimension data types. |
static class |
IEssDimension.EEssDimensionCategory EEssDimensionCategory class is the dimension category. |
static class |
IEssDimension.EEssDimensionStorageCategory EEssDimensionStorageCategory class is the Dimension storage category. |
static class |
IEssDimension.EEssDimensionStorageType EEssDimensionStorageType class is the dimension storage type. |
static class |
IEssDimension.EEssDimensionTag EEssDimensionTag class is the enumeration of dimension tags. |
Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties |
---|
IEssProperties.EEssPropertyMode |
Field Summary | |
---|---|
static int |
PROP_ACTUAL_SIZE |
static int |
PROP_DECLARED_SIZE |
static int |
PROP_NAME |
static int |
PROP_NUMBER |
static int |
PROP_TAG |
static int |
PROP_TYPE |
static int |
s_countProperties |
static IEssValueAny.EEssDataType[] |
s_propDataTypes |
static IEssProperties.EEssPropertyMode[] |
s_propModes |
static java.lang.String[] |
s_propNames |
Method Summary | |
---|---|
void |
clearGenerationName(int genNum) Clears the name of a specific generation. |
void |
clearLevelName(int levelNum) Clears the name of a specific level. |
void |
delete(java.lang.String dataMbrName) Delete the dimension from the outline. |
int |
getActualSize() Gets the actual dimension size. |
IEssDimension.EEssAttributeDataType |
getAttributeDimensionDataType() Gets the attribute dimension data type. |
IEssDimension.EEssDimensionCategory |
getCategory() Gets the dimension category. |
int |
getDeclaredSize() Gets the declared dimension size. |
java.lang.String |
getDescription() Gets the dimension description. |
boolean |
getDimensionNameUniqueness() Returns if the Dimension Uniqueness is enabled or disabled. |
int |
getDimensionNumber() Gets the dimension number. |
IEssMember |
getDimensionRootMember() Gets the root member for this dimension. |
IEssGeneration |
getGeneration(int genNum) Gets the generation for the specified generation number. |
java.lang.String |
getGenerationName(int genNum) Gets the generation name for the specified generation number. |
IEssIterator |
getGenerations() Gets all the generations in this dimension. |
IEssLevel |
getLevel(int levelNum) Gets the level for the specified level number. |
java.lang.String |
getLevelName(int levelNum) Gets the level name for the specified level number. |
IEssIterator |
getLevels() Gets all the levels in this dimension. |
java.lang.String |
getName() Gets the dimension name. |
IEssDimension.EEssDimensionStorageType |
getStorageType() Gets the dimension storage type. |
IEssDimension.EEssDimensionTag |
getTag() Gets the dimension tag. |
java.lang.String[] |
getUDAs() Gets all the User Defined Attributes (used by one or more members) in this dimension. |
void |
refreshPropertyValues() Refreshes the property values. |
void |
setAttributeDimensionDataType(IEssDimension.EEssAttributeDataType attrDimDataType) Gets the attribute dimension data type. |
void |
setCategory(IEssDimension.EEssDimensionCategory dimCategory) Sets the dimension category. |
void |
setDescription(java.lang.String desc) Sets the dimension description for standard. |
void |
setDimensionNameUniqueness(boolean enableUnique) If uniqueness is enabled for this Dimension, then, any member referred through this Dimension cannot have duplicate member names. |
void |
setGenerationName(int genNum, java.lang.String genName) Sets the generation name for the specified generation number. |
void |
setGenerationName(int genNum, java.lang.String genName, boolean enableUniqName) Sets the generation name for the specified generation number. |
void |
setLevelName(int levelNum, java.lang.String levelName) Sets the level name for the specified level number. |
void |
setLevelName(int levelNum, java.lang.String levelName, boolean enableUniqName) Sets the level name for the specified level number. |
void |
setStorageType(IEssDimension.EEssDimensionStorageType storageType) Sets the dimension storage type. |
void |
updatePropertyValues() Updates the property values. |
Methods inherited from interface com.essbase.api.base.IEssExtendedObject |
---|
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled |
Methods inherited from interface com.essbase.api.base.IEssProperties |
---|
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny |
Field Detail |
---|
static final int PROP_NAME
static final int PROP_NUMBER
static final int PROP_TYPE
static final int PROP_TAG
static final int PROP_DECLARED_SIZE
static final int PROP_ACTUAL_SIZE
static final int s_countProperties
static final java.lang.String[] s_propNames
static final IEssValueAny.EEssDataType[] s_propDataTypes
static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
---|
java.lang.String getName() throws com.essbase.api.base.EssException
getName
in interface IEssExtendedObject
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDescription() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDescription(java.lang.String desc) throws com.essbase.api.base.EssException
desc
- The dimension description.com.essbase.api.base.EssException
- if an error occurs.int getDimensionNumber() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssDimension.EEssDimensionStorageType getStorageType() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setStorageType(IEssDimension.EEssDimensionStorageType storageType) throws com.essbase.api.base.EssException
storageType
- The dimension storage type.com.essbase.api.base.EssException
- if an error occurs.IEssDimension.EEssDimensionCategory getCategory() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setCategory(IEssDimension.EEssDimensionCategory dimCategory) throws com.essbase.api.base.EssException
dimCategory
- The dimension category.com.essbase.api.base.EssException
- if an error occurs.IEssDimension.EEssAttributeDataType getAttributeDimensionDataType() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setAttributeDimensionDataType(IEssDimension.EEssAttributeDataType attrDimDataType) throws com.essbase.api.base.EssException
attrDimDataType
- The attribute dimension data type.com.essbase.api.base.EssException
- if an error occurs.IEssDimension.EEssDimensionTag getTag() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.int getDeclaredSize() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.int getActualSize() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void refreshPropertyValues() throws com.essbase.api.base.EssException
refreshPropertyValues
in interface IEssProperties
com.essbase.api.base.EssException
- if an error occurs.void updatePropertyValues() throws com.essbase.api.base.EssException
updatePropertyValues
in interface IEssProperties
com.essbase.api.base.EssException
- if an error occurs.void delete(java.lang.String dataMbrName) throws com.essbase.api.base.EssException
dataMbrName
- The member name in the dimension to be deleted from which data will be saved when the outline is restructured. If this field is null, the dimension is used.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getGenerationName(int genNum) throws com.essbase.api.base.EssException
genNum
- The number of the generation for which to get a name. The dimension itself is generation 1.com.essbase.api.base.EssException
- if an error occurs.void setGenerationName(int genNum, java.lang.String genName) throws com.essbase.api.base.EssException
genNum
- The number of the generation for which to set a name. The dimension itself is generation 1.genName
- The name to give the generation.com.essbase.api.base.EssException
- if an error occurs.void clearGenerationName(int genNum) throws com.essbase.api.base.EssException
genNum
- The number of the generation for which to delete name.com.essbase.api.base.EssException
- if an error occurs.IEssIterator getGenerations() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getLevelName(int levelNum) throws com.essbase.api.base.EssException
levelNum
- The number of the level for which to get a name. The leaf members are level 0.com.essbase.api.base.EssException
- if an error occurs.void setLevelName(int levelNum, java.lang.String levelName) throws com.essbase.api.base.EssException
levelNum
- The number of the level for which to set a name. The leaf members are level 0.levelName
- The name to give the level.com.essbase.api.base.EssException
- if an error occurs.void clearLevelName(int levelNum) throws com.essbase.api.base.EssException
levelNum
- The number of the level for which to delete name.com.essbase.api.base.EssException
- if an error occurs.IEssIterator getLevels() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String[] getUDAs() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssMember getDimensionRootMember() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDimensionNameUniqueness(boolean enableUnique) throws com.essbase.api.base.EssException
enableUnique
- Enable or Disable Uniquenesscom.essbase.api.base.EssException
- if an error occurs.boolean getDimensionNameUniqueness() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setGenerationName(int genNum, java.lang.String genName, boolean enableUniqName) throws com.essbase.api.base.EssException
genNum
- The number of the generation for which to set a name. The dimension itself is generation 1.genName
- The name to give the generation.enableUniqName
- If true, members at genNum in this Dimension cannot have duplicate names.com.essbase.api.base.EssException
- if an error occurs.IEssGeneration getGeneration(int genNum) throws com.essbase.api.base.EssException
genNum
- The number of the generation for which to get a name. The dimension itself is generation 1.com.essbase.api.base.EssException
- if an error occurs.void setLevelName(int levelNum, java.lang.String levelName, boolean enableUniqName) throws com.essbase.api.base.EssException
levelNum
- The number of the level for which to set a name. The leaf members are level 0.levelName
- The name to give the level.enableUniqName
- If true, members at levelNum in this Dimension cannot have duplicate names.com.essbase.api.base.EssException
- if an error occurs.IEssLevel getLevel(int levelNum) throws com.essbase.api.base.EssException
levelNum
- The number of the level for which to set a name. The leaf members are level 0.com.essbase.api.base.EssException
- if an error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |