Skip navigation links

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.essbase.api.metadata
Interface IEssMember

All Superinterfaces:
IEssBaseObject, IEssExtendedObject, IEssProperties
All Known Subinterfaces:
IEssMemberWithIndepMbrsSet
public interface IEssMember
extends IEssExtendedObject, IEssProperties

The IEssMember interface.

Version:
1.0, 04/04/2001
Author:
Srini Ranga

Nested Class Summary
static class IEssMember.EEssConsolidationType
          EEssConsolidationType class is the unary consolidation type.
static class IEssMember.EEssCurrencyConversionType
          EEssCurrencyConversionType class is the currency conversion type.
static class IEssMember.EEssHierarchyType
          EEssHierarchyType class is the enumeration of types of Hierarchy.
static class IEssMember.EEssShareOption
          EEssShareOption class is the enumeration of data storage share options.
static class IEssMember.EEssTimeBalanceOption
          EEssTimeBalanceOption class is the enumeration of time balance options.
static class IEssMember.EEssTimeBalanceSkipOption
          EEssTimeBalanceSkipOption class is the time balance skip option.

 

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

 

Field Summary
static short ESS_AGGLEVELUSAGE_ALL
          Consider all levels for aggregation.
static short ESS_AGGLEVELUSAGE_BOTTOMONLY
          Applies only to secondary hierarchies.
static short ESS_AGGLEVELUSAGE_BOTTOMTOP
          Applies to primary hierarchies.
static short ESS_AGGLEVELUSAGE_DEFAULT
          On primary hierarchies, consider all levels.
static short ESS_AGGLEVELUSAGE_NOAGGREGATION
          Do not aggregate along this hierarchy.
static short ESS_AGGLEVELUSAGE_NOTSET
          No setting.
static short ESS_AGGLEVELUSAGE_TOPONLY
          Applies only to primary hierarchies.
static short ESS_MEMBERTYPE_DATE
           
static short ESS_MEMBERTYPE_NONE
           
static short ESS_MEMBERTYPE_NUMERIC
           
static short ESS_MEMBERTYPE_SMARTLIST
           
static short ESS_VERIFY_ALL
           
static short ESS_VERIFY_DEFER
           
static short ESS_VERIFY_NAMEONLY
           
static short ESS_VERIFY_ORDER_DEPENDENT
           
static short ESS_VERIFY_ORDER_INDEPENDENT
           
static int PROP_ATTRIBUTE_VALUE
           
static int PROP_CHILD_COUNT
           
static int PROP_CONSOLIDATION_TYPE
           
static int PROP_CURRENCY_CATEGORY_OR_NAME
           
static int PROP_CURRENCY_CONVERSION_TYPE
           
static int PROP_DESCRIPTION
           
static int PROP_DIMENSION_NAME
           
static int PROP_DIMENSION_SOLVE_ORDER
           
static int PROP_GENERATION_NUMBER
           
static int PROP_HIERARCHY_TYPE
           
static int PROP_INDEPENDENT_DIM
           
static int PROP_IS_ATTRIBUTES_ASSOCIATED
           
static int PROP_IS_DIMENSION_ROOT
           
static int PROP_IS_EXPENSE_MEMBER
           
static int PROP_IS_TWO_PASS_CALC_MEMBER
           
static int PROP_LEVEL_NUMBER
           
static int PROP_NAME
           
static int PROP_SHARE_OPTION
           
static int PROP_SOLVE_ORDER
           
static int PROP_TIME_BALANCE_OPTION
           
static int PROP_TIME_BALANCE_SKIP_OPTION
           
static int PROP_UNIQUE_NAME
           
static int s_countProperties
           
static IEssValueAny.EEssDataType[] s_propDataTypes
           
static IEssProperties.EEssPropertyMode[] s_propModes
           
static java.lang.String[] s_propNames
           

 

Method Summary
 void addAliasCombination(java.lang.String aliasTableName, java.lang.String alias, java.lang.String mbrCombination)
          Deprecated. This function is deprecated in 7.1 version.
 IEssMember createChildAttributeMember(java.lang.String name, IEssDimension.EEssAttributeDataType attrDataType, IEssMember prevSibling)
          Creates a child attribute member.
 IEssMember createChildMember(java.lang.String name)
          Creates a child member.
 IEssMember createChildMember(java.lang.String name, IEssMember prevSibling)
          Creates a child member.
 IEssMember createChildMember(java.lang.String name, IEssMember prevSibling, IEssMember.EEssShareOption shareOption)
          Creates a child member.
 IEssMember createChildMember(java.lang.String name, IEssMember prevSibling, java.lang.String description, IEssMember.EEssConsolidationType consolidation, boolean twoPass, boolean expense, IEssMember.EEssCurrencyConversionType conversion, java.lang.String curCatOrName, IEssMember.EEssTimeBalanceOption timeBalance, IEssMember.EEssTimeBalanceSkipOption timeBalSkip, IEssMember.EEssShareOption shareOption)
          Creates a child member.
 void createUDA(java.lang.String uda)
          Creates a User Defined Attribute for this member.
 void delete()
          Delete the member from the outline with ESS_VERIFY_ALL option.
 void delete(short verifyType)
          Deletes the member from the outline.
 void deleteAlias(java.lang.String aliasTableName)
          Deletes the default member alias for this member in a specific alias table.
 void deleteAliasCombination(java.lang.String aliasTableName, java.lang.String alias)
          Deprecated. This function is deprecated in 7.1 version.
 void deleteFormula()
          Deletes the member formula.
 void deleteMemberId()
          Delete member ID(if any) attached to this member.
 void deleteUDA(java.lang.String uda)
          Deletes a User Defined Attribute for this member.
 short getAggregationLevelUsage()
          Returns the aggregation level usage of this member, the applied view selection properties on stored hierarchies.
 java.lang.String getAlias(java.lang.String aliasTableName)
          Gets the default member alias for this member in a specific alias table.
 java.lang.String[] getAliasCombinations(java.lang.String aliasTableName)
          Deprecated. This function is deprecated in 7.1 version.
 IEssIterator getAssociatedAttributes()
          Gets all attribute members that are associated with a base member or dimension.
 short getAttributeAssocLevel()
          For every Attribute dimension defined, there is an association level defined based on the base dimension Level its associated with.
 IEssDimension.EEssAttributeDataType getAttributeMemberDataType()
          Gets the attribute member data type.
 IEssValueAny getAttributeValue()
          Gets the attribute value.
 int getChildCount()
          Gets the total number of children of this member.
 IEssIterator getChildMembers()
          Gets the list of child members.
 IEssIterator getChildMembers(boolean withAllProps)
          Gets the list of child members.
 IEssMember.EEssConsolidationType getConsolidationType()
          Gets unary consolidation type.
 long getCountOfDupMemberNameInDim()
          Returns the number of members in a dimension whose names are duplicate in the outline opened in query mode
 java.lang.String getCurrencyCategoryOrName()
          Gets the currency category (If member is of the accounts dimension and currency conversion (EEssCurrencyConversionType) is CATEGORY) or the currency name (If member is of the Country dimension).
 IEssMember.EEssCurrencyConversionType getCurrencyConversionType()
          Gets the currency conversion type.
 java.lang.String getDescription()
          Gets the member description.
 IEssDimension.EEssDimensionCategory getDimensionCategory()
          Gets the Dimension category.
 java.lang.String getDimensionName()
          Gets the member's dimension name.
 int getDimensionNumber()
          Gets the member's dimension number.
 short getDimensionSolveOrder()
          Returns the default solveOrder for all members which do not have their own Solve Order.
 IEssDimension.EEssDimensionStorageCategory getDimensionStorageCategory()
          Gets the dimension storage category.
 IEssDimension.EEssDimensionStorageType getDimensionStorageType()
          Gets the Dimension storage type.
 java.lang.String getFirstChildMemberName()
          Deprecated.  
 java.lang.String getFormatString()
          Gets the format String
 java.lang.String getFormula()
          Gets the member formula.
 int getGenerationNumber()
          Gets the level of the generation in the outline.
 IEssMember.EEssHierarchyType getHierarchyType()
          Returns the hierarchy type of this member.
 java.lang.String getLastFormula()
          Deprecated. Since 11.1.1.1.00.
 int getLevelNumber()
          Gets the level of the member in the outline.
 short getLinkedAttributeAttachLevel()
          For every Linked value attribute (LVA) defined, there is an association level and an attachment level associated with the attribute dimension definition.
 java.lang.String getMemberComment()
          Gets the Extended Member Comment for a given member This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
 java.lang.String getMemberId()
          If there is a member ID for this member, then return it.
 int getMemberNumber()
          Gets the member number (The position of the member starting from bottom left in the dimension hierarchy).
 short getMemberType()
          Gets the member type.
 java.lang.String getName()
          Gets the member name.
 java.lang.String getNextSiblingMemberName()
          Deprecated.  
 java.lang.String getOriginalMemberName()
          If this member is a extended shared member, it returns its original member name.
 java.lang.String getParentMemberName()
          Gets the parent member name.
 java.lang.String getPreviousSiblingMemberName()
          Deprecated.  
 java.lang.String[] getRelatedMemberNames()
          Gets the name of the parent, previous sibling, next sibling, first child.
 IEssMember.EEssShareOption getShareOption()
          Gets the data storage share option.
 IEssSmartList getSmartList()
          Gets the associated smartlist instance.
 short getSolveOrder()
          Returns the SolveOrder number 0 to 127 that decides in which order dynamic member values are calculated.
 IEssMember.EEssTimeBalanceOption getTimeBalanceOption()
          Gets the time balance option.
 IEssMember.EEssTimeBalanceSkipOption getTimeBalanceSkipOption()
          Gets the time balance skip option.
 java.lang.String[] getUDAs()
          Gets the User Defined Attributes of this member.
 java.lang.String getUniqueName()
          If this member’s name is not unique, it returns the minimum composed name, otherwise it returns the member name.
 boolean isAttributesAssociated()
          Checks if this member has attributes associated with it.
 boolean isDimensionRootMember()
          Checks if this member is the root member of the dimension to which it belongs.
 boolean isExpenseMember()
          Checks if expense member.
 boolean isFlowType()
          Indicates that member is type Flow.
 boolean isIndependentDim()
          Checks to see if this object represents an independent dimension.
 boolean isMemberNameUniqueWithinDim()
          Discovers if member names are all unique within a dimension.
 boolean isMemberNameUniqueWithinDimAtGenLevel(boolean bGen, short sGenLevel)
          Discovers if all member names are unique within a dimension at the generation or level specified.
 boolean isNameUnique()
          Check to see if this member's name is unique within the outline this member belongs to.
 boolean isRelationalDescendantPresent()
          Checks if relational descendant is present.
 boolean isRelationalPartitionEnabled()
          Checks if relational partition is enabled.
 boolean isTwoPassCalculationMember()
          Checks if two-pass calculation member.
 void refreshPropertyValues()
          Refreshes the property values.
 void rename(java.lang.String newMbrName)
          Renames the member.
 void setAggregationLevelUsage(short aggLevel)
          Sets the aggregation level usage of this member.
 void setAlias(java.lang.String aliasTableName, java.lang.String alias)
          Sets the default member alias for this member in a specific alias table.
 void setAttributeMemberDataType(IEssDimension.EEssAttributeDataType attrMbrDataType)
          Sets the attribute member data type.
 void setConsolidationType(IEssMember.EEssConsolidationType consolidation)
          Sets unary consolidation type.
 void setCurrencyCategoryOrName(java.lang.String curCatOrName)
          Sets the currency category (If member is of the accounts dimension and currency conversion (EEssCurrencyConversionType) is CATEGORY) or the currency name (If member is of the Country dimension).
 void setCurrencyConversionType(IEssMember.EEssCurrencyConversionType conversion)
          Sets the currency conversion type.
 void setDescription(java.lang.String description)
          Sets the member description.
 void setDimensionSolveOrder(short dimSolveOrder)
          Sets the Dimension solve order number.
 void setExpenseMember(boolean expense)
          Sets if expense member.
 void setFlowType(boolean flow)
          Set the member to type Flow.
 void setFormatString(java.lang.String formatString)
          Sets format string.
 void setFormula(java.lang.String formula)
          Sets the member formula.
 void setHierarchyType(IEssMember.EEssHierarchyType hierType)
          Sets the specified Hierarchy Type.
 void setIndependentDim(boolean independentDim)
          Set the Dimension to either independent or dependent.
 void setMemberComment(java.lang.String comment)
          Sets the Extended Member Comment
 void setMemberId(java.lang.String memberID)
          Assigns the given member ID to this member.
 void setMemberType(short memberType)
          Sets the member type.
 void setOriginalMemberName(java.lang.String origMbrName)
          This is to make this member as an extended shared member.
 void setRelationalDescendantPresent(boolean relDesc)
          Sets if relational descendant is present.
 void setRelationalPartitionEnabled(boolean relPartEnabled)
          Sets if relational partition is enabled.
 void setShareOption(IEssMember.EEssShareOption share)
          Sets the data storage share option.
 void setSmartList(IEssSmartList smartList)
          Sets the specified smartlist for the given member.
 void setSolveOrder(short solveOrder)
          Sets the SolveOrder number (Valid Range: 0 to 127) that decides in which order dynamic member values are calculated.
 void setTimeBalanceOption(IEssMember.EEssTimeBalanceOption timeBalance)
          Sets the time balance option.
 void setTimeBalanceSkipOption(IEssMember.EEssTimeBalanceSkipOption timeBalSkip)
          Sets the Time balance skip option.
 void setTwoPassCalculationMember(boolean twoPass)
          Sets if two-pass calculation member.
 void sortChildren(boolean ascending)
          Sorts the children of this member.
 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

PROP_NAME

static final int PROP_NAME
See Also:
Constant Field Values

PROP_DESCRIPTION

static final int PROP_DESCRIPTION
See Also:
Constant Field Values

PROP_IS_DIMENSION_ROOT

static final int PROP_IS_DIMENSION_ROOT
See Also:
Constant Field Values

PROP_LEVEL_NUMBER

static final int PROP_LEVEL_NUMBER
See Also:
Constant Field Values

PROP_GENERATION_NUMBER

static final int PROP_GENERATION_NUMBER
See Also:
Constant Field Values

PROP_CONSOLIDATION_TYPE

static final int PROP_CONSOLIDATION_TYPE
See Also:
Constant Field Values

PROP_IS_TWO_PASS_CALC_MEMBER

static final int PROP_IS_TWO_PASS_CALC_MEMBER
See Also:
Constant Field Values

PROP_IS_EXPENSE_MEMBER

static final int PROP_IS_EXPENSE_MEMBER
See Also:
Constant Field Values

PROP_CURRENCY_CONVERSION_TYPE

static final int PROP_CURRENCY_CONVERSION_TYPE
See Also:
Constant Field Values

PROP_CURRENCY_CATEGORY_OR_NAME

static final int PROP_CURRENCY_CATEGORY_OR_NAME
See Also:
Constant Field Values

PROP_TIME_BALANCE_OPTION

static final int PROP_TIME_BALANCE_OPTION
See Also:
Constant Field Values

PROP_TIME_BALANCE_SKIP_OPTION

static final int PROP_TIME_BALANCE_SKIP_OPTION
See Also:
Constant Field Values

PROP_SHARE_OPTION

static final int PROP_SHARE_OPTION
See Also:
Constant Field Values

PROP_CHILD_COUNT

static final int PROP_CHILD_COUNT
See Also:
Constant Field Values

PROP_IS_ATTRIBUTES_ASSOCIATED

static final int PROP_IS_ATTRIBUTES_ASSOCIATED
See Also:
Constant Field Values

PROP_ATTRIBUTE_VALUE

static final int PROP_ATTRIBUTE_VALUE
See Also:
Constant Field Values

PROP_DIMENSION_NAME

static final int PROP_DIMENSION_NAME
See Also:
Constant Field Values

PROP_UNIQUE_NAME

static final int PROP_UNIQUE_NAME
See Also:
Constant Field Values

PROP_INDEPENDENT_DIM

static final int PROP_INDEPENDENT_DIM
See Also:
Constant Field Values

PROP_HIERARCHY_TYPE

static final int PROP_HIERARCHY_TYPE
See Also:
Constant Field Values

PROP_DIMENSION_SOLVE_ORDER

static final int PROP_DIMENSION_SOLVE_ORDER
See Also:
Constant Field Values

PROP_SOLVE_ORDER

static final int PROP_SOLVE_ORDER
See Also:
Constant Field Values

s_countProperties

static final int s_countProperties
See Also:
Constant Field Values

s_propNames

static final java.lang.String[] s_propNames

s_propDataTypes

static final IEssValueAny.EEssDataType[] s_propDataTypes

s_propModes

static final IEssProperties.EEssPropertyMode[] s_propModes

ESS_VERIFY_ALL

static final short ESS_VERIFY_ALL
See Also:
Constant Field Values

ESS_VERIFY_ORDER_INDEPENDENT

static final short ESS_VERIFY_ORDER_INDEPENDENT
See Also:
Constant Field Values

ESS_VERIFY_ORDER_DEPENDENT

static final short ESS_VERIFY_ORDER_DEPENDENT
See Also:
Constant Field Values

ESS_VERIFY_DEFER

static final short ESS_VERIFY_DEFER
See Also:
Constant Field Values

ESS_VERIFY_NAMEONLY

static final short ESS_VERIFY_NAMEONLY
See Also:
Constant Field Values

ESS_MEMBERTYPE_NONE

static final short ESS_MEMBERTYPE_NONE
See Also:
Constant Field Values

ESS_MEMBERTYPE_NUMERIC

static final short ESS_MEMBERTYPE_NUMERIC
See Also:
Constant Field Values

ESS_MEMBERTYPE_SMARTLIST

static final short ESS_MEMBERTYPE_SMARTLIST
See Also:
Constant Field Values

ESS_MEMBERTYPE_DATE

static final short ESS_MEMBERTYPE_DATE
See Also:
Constant Field Values

ESS_AGGLEVELUSAGE_NOTSET

static final short ESS_AGGLEVELUSAGE_NOTSET
No setting.
See Also:
Constant Field Values

ESS_AGGLEVELUSAGE_DEFAULT

static final short ESS_AGGLEVELUSAGE_DEFAULT
On primary hierarchies, consider all levels. Do not aggregate secondary hierarchies unless alternate rollups are enabled.
See Also:
Constant Field Values

ESS_AGGLEVELUSAGE_ALL

static final short ESS_AGGLEVELUSAGE_ALL
Consider all levels for aggregation. This is same as default for primary hierarchies, but not for secondary hierarchies.
See Also:
Constant Field Values

ESS_AGGLEVELUSAGE_NOAGGREGATION

static final short ESS_AGGLEVELUSAGE_NOAGGREGATION
Do not aggregate along this hierarchy. All views selected are at the input level.
See Also:
Constant Field Values

ESS_AGGLEVELUSAGE_BOTTOMONLY

static final short ESS_AGGLEVELUSAGE_BOTTOMONLY
Applies only to secondary hierarchies. Consider only lowest level of this hierarchy for aggregation.
See Also:
Constant Field Values

ESS_AGGLEVELUSAGE_TOPONLY

static final short ESS_AGGLEVELUSAGE_TOPONLY
Applies only to primary hierarchies. Consider only topmost level of this hierarchy for aggregation
See Also:
Constant Field Values

ESS_AGGLEVELUSAGE_BOTTOMTOP

static final short ESS_AGGLEVELUSAGE_BOTTOMTOP
Applies to primary hierarchies. Select top and bottom levels only.
See Also:
Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws com.essbase.api.base.EssException
Gets the member name.
Specified by:
getName in interface IEssExtendedObject
Returns:
The member name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDescription

java.lang.String getDescription()
                                throws com.essbase.api.base.EssException
Gets the member description. This method is effective only for standard/ base member. For attribute member, this method always returns "";
Returns:
The member description.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setDescription

void setDescription(java.lang.String description)
                    throws com.essbase.api.base.EssException
Sets the member description. This method is effective only for standard/ base member, and has no effect for the attribute member. The change will become effective after you invoke updatePropertyValues().
Parameters:
description - The member description.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isDimensionRootMember

boolean isDimensionRootMember()
                              throws com.essbase.api.base.EssException
Checks if this member is the root member of the dimension to which it belongs.
Returns:
true if this object is a dimension, false if it is a member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getLevelNumber

int getLevelNumber()
                   throws com.essbase.api.base.EssException
Gets the level of the member in the outline. The level number is zero-based, counting up from the lowest descendent of the specified member.
Returns:
The level number.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getGenerationNumber

int getGenerationNumber()
                        throws com.essbase.api.base.EssException
Gets the level of the generation in the outline. The generation number is one-based, counting down from the specified member's dimension member.
Returns:
The generation number.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getConsolidationType

IEssMember.EEssConsolidationType getConsolidationType()
                                                      throws com.essbase.api.base.EssException
Gets unary consolidation type.
Returns:
The unary consolidation type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setConsolidationType

void setConsolidationType(IEssMember.EEssConsolidationType consolidation)
                          throws com.essbase.api.base.EssException
Sets unary consolidation type. The change will become effective after you invoke updatePropertyValues().
Parameters:
consolidation - The unary consolidation type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isTwoPassCalculationMember

boolean isTwoPassCalculationMember()
                                   throws com.essbase.api.base.EssException
Checks if two-pass calculation member. This operation is not allowed on member objects obtained using IEssCube.getMember(String) or IEssCubeView.memberSelection().
Returns:
true if two-pass calculation member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setTwoPassCalculationMember

void setTwoPassCalculationMember(boolean twoPass)
                                 throws com.essbase.api.base.EssException
Sets if two-pass calculation member. The change will become effective after you invoke updatePropertyValues().
Parameters:
twoPass - true if two-pass calculation member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isExpenseMember

boolean isExpenseMember()
                        throws com.essbase.api.base.EssException
Checks if expense member. This is valid only for members of the accounts dimension. This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
Returns:
true if expense member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setExpenseMember

void setExpenseMember(boolean expense)
                      throws com.essbase.api.base.EssException
Sets if expense member. This is valid only for members of the accounts dimension. The change will become effective after you invoke updatePropertyValues().
Parameters:
expense - true if expense member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCurrencyConversionType

IEssMember.EEssCurrencyConversionType getCurrencyConversionType()
                                                                throws com.essbase.api.base.EssException
Gets the currency conversion type. This is valid only for members of the Accounts dimension. This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
Returns:
The currency conversion type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setCurrencyConversionType

void setCurrencyConversionType(IEssMember.EEssCurrencyConversionType conversion)
                               throws com.essbase.api.base.EssException
Sets the currency conversion type. This is valid only for members of the Accounts dimension. The change will become effective after you invoke updatePropertyValues().
Parameters:
conversion - The currency conversion type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCurrencyCategoryOrName

java.lang.String getCurrencyCategoryOrName()
                                           throws com.essbase.api.base.EssException
Gets the currency category (If member is of the accounts dimension and currency conversion (EEssCurrencyConversionType) is CATEGORY) or the currency name (If member is of the Country dimension). This field is undefined in all other situations. This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
Returns:
The currency category or the currency name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setCurrencyCategoryOrName

void setCurrencyCategoryOrName(java.lang.String curCatOrName)
                               throws com.essbase.api.base.EssException
Sets the currency category (If member is of the accounts dimension and currency conversion (EEssCurrencyConversionType) is CATEGORY) or the currency name (If member is of the Country dimension). This field is undefined in all other situations. The change will become effective after you invoke updatePropertyValues().
Parameters:
curCatOrName - The currency category or the currency name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getTimeBalanceOption

IEssMember.EEssTimeBalanceOption getTimeBalanceOption()
                                                      throws com.essbase.api.base.EssException
Gets the time balance option. This field is valid only for members of the accounts dimension. This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
Returns:
The time balance option.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setTimeBalanceOption

void setTimeBalanceOption(IEssMember.EEssTimeBalanceOption timeBalance)
                          throws com.essbase.api.base.EssException
Sets the time balance option. This field is valid only for members of the Accounts dimension. The change will become effective after you invoke updatePropertyValues().
Parameters:
timeBalance - The time balance option.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getTimeBalanceSkipOption

IEssMember.EEssTimeBalanceSkipOption getTimeBalanceSkipOption()
                                                              throws com.essbase.api.base.EssException
Gets the time balance skip option. This is valid only for members of the Accounts dimension if time balance (EEssTimeBalanceOption) is not equal to NONE. This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
Returns:
The time balance skip option.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setTimeBalanceSkipOption

void setTimeBalanceSkipOption(IEssMember.EEssTimeBalanceSkipOption timeBalSkip)
                              throws com.essbase.api.base.EssException
Sets the Time balance skip option. This is valid only for members of the Accounts dimension if time balance (EEssTimeBalanceOption) is not equal to NONE. The change will become effective after you invoke updatePropertyValues().
Parameters:
timeBalSkip - The time balance skip option.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getShareOption

IEssMember.EEssShareOption getShareOption()
                                          throws com.essbase.api.base.EssException
Gets the data storage share option. This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
Returns:
The share option.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setShareOption

void setShareOption(IEssMember.EEssShareOption share)
                    throws com.essbase.api.base.EssException
Sets the data storage share option. The change will become effective after you invoke updatePropertyValues().
Parameters:
share - The share option.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDimensionStorageType

IEssDimension.EEssDimensionStorageType getDimensionStorageType()
                                                               throws com.essbase.api.base.EssException
Gets the Dimension storage type. This is valid only for dimension root member. This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
Returns:
The Dimension storage type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDimensionCategory

IEssDimension.EEssDimensionCategory getDimensionCategory()
                                                         throws com.essbase.api.base.EssException
Gets the Dimension category. This is valid only for dimension root and attribute members. This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
Returns:
The Dimension category.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDimensionStorageCategory

IEssDimension.EEssDimensionStorageCategory getDimensionStorageCategory()
                                                                       throws com.essbase.api.base.EssException
Gets the dimension storage category. This is valid only for dimension and attribute members. Optimizes the storage types of dimensions when the outline is configured for automatic optimization. This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
Returns:
The dimension storage category.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAttributeMemberDataType

IEssDimension.EEssAttributeDataType getAttributeMemberDataType()
                                                               throws com.essbase.api.base.EssException
Gets the attribute member data type. This method is to be used only for attribute members.
Returns:
The attribute member data type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setAttributeMemberDataType

void setAttributeMemberDataType(IEssDimension.EEssAttributeDataType attrMbrDataType)
                                throws com.essbase.api.base.EssException
Sets the attribute member data type. This method is to be used only for attribute members. The change will become effective after you invoke updatePropertyValues().
Parameters:
attrMbrDataType - The attribute member data type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getChildCount

int getChildCount()
                  throws com.essbase.api.base.EssException
Gets the total number of children of this member.
Returns:
The child count. This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
Throws:
com.essbase.api.base.EssException - if an error occurs.

isAttributesAssociated

boolean isAttributesAssociated()
                               throws com.essbase.api.base.EssException
Checks if this member has attributes associated with it.
Returns:
true if attributes are associated with this member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAttributeValue

IEssValueAny getAttributeValue()
                               throws com.essbase.api.base.EssException
Gets the attribute value. NOTE: The date attribute value is stored as GMT.
Returns:
The attribute value (with type of: boolean or double or Date or String)
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDimensionName

java.lang.String getDimensionName()
                                  throws com.essbase.api.base.EssException
Gets the member's dimension name.
Returns:
The dimension name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getParentMemberName

java.lang.String getParentMemberName()
                                     throws com.essbase.api.base.EssException
Gets the parent member name.
Returns:
The parent member name. "" if the member has no parent.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getFirstChildMemberName

java.lang.String getFirstChildMemberName()
                                         throws com.essbase.api.base.EssException
Deprecated. 
Gets the first child member name.
Returns:
The first child member name. "" if the member has no child.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getPreviousSiblingMemberName

java.lang.String getPreviousSiblingMemberName()
                                              throws com.essbase.api.base.EssException
Deprecated. 
Gets the previous sibling member name.
Returns:
The previous sibling member name. "" if the member has no previous sibling.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getNextSiblingMemberName

java.lang.String getNextSiblingMemberName()
                                          throws com.essbase.api.base.EssException
Deprecated. 
Gets the next sibling member name.
Returns:
The next sibling member name. "" if the member has no next sibling.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getMemberNumber

int getMemberNumber()
                    throws com.essbase.api.base.EssException
Gets the member number (The position of the member starting from bottom left in the dimension hierarchy). This may return different value based on if the member instance was retrieved after executing a member-selection like "<selectMbrInfo (memberNumber)", which assigns same number to shared members as their prototype member, including "implied share" members. In other cases, this returns the internal variable "memnor" which assigns a unique member-number to each member.
Returns:
The member number.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDimensionNumber

int getDimensionNumber()
                       throws com.essbase.api.base.EssException
Gets the member's dimension number.
Returns:
The dimension number.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isRelationalDescendantPresent

boolean isRelationalDescendantPresent()
                                      throws com.essbase.api.base.EssException
Checks if relational descendant is present.
Returns:
true if relational descendant is present.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setRelationalDescendantPresent

void setRelationalDescendantPresent(boolean relDesc)
                                    throws com.essbase.api.base.EssException
Sets if relational descendant is present.
Parameters:
relDesc - true if relational descendant is present.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isRelationalPartitionEnabled

boolean isRelationalPartitionEnabled()
                                     throws com.essbase.api.base.EssException
Checks if relational partition is enabled.
Returns:
true if relational partition is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setRelationalPartitionEnabled

void setRelationalPartitionEnabled(boolean relPartEnabled)
                                   throws com.essbase.api.base.EssException
Sets if relational partition is enabled.
Parameters:
relPartEnabled - true if relational partition is enabled.
Throws:
com.essbase.api.base.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.
Specified by:
refreshPropertyValues in interface IEssProperties
Throws:
com.essbase.api.base.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().
Specified by:
updatePropertyValues in interface IEssProperties
Throws:
com.essbase.api.base.EssException - if an error occurs.

createChildMember

IEssMember createChildMember(java.lang.String name)
                             throws com.essbase.api.base.EssException
Creates a child member.
Parameters:
name - The member name to create.
Returns:
The child member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createChildMember

IEssMember createChildMember(java.lang.String name,
                             IEssMember prevSibling)
                             throws com.essbase.api.base.EssException
Creates a child member.
Parameters:
name - The member name to create.
prevSibling - The previous sibling member. The new member will be placed after this member.
Returns:
The child member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createChildMember

IEssMember createChildMember(java.lang.String name,
                             IEssMember prevSibling,
                             IEssMember.EEssShareOption shareOption)
                             throws com.essbase.api.base.EssException
Creates a child member.
Parameters:
name - The member name to create.
prevSibling - The previous sibling member. The new member will be placed after this member.
shareOption - The share option.
Returns:
The child member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createChildMember

IEssMember createChildMember(java.lang.String name,
                             IEssMember prevSibling,
                             java.lang.String description,
                             IEssMember.EEssConsolidationType consolidation,
                             boolean twoPass,
                             boolean expense,
                             IEssMember.EEssCurrencyConversionType conversion,
                             java.lang.String curCatOrName,
                             IEssMember.EEssTimeBalanceOption timeBalance,
                             IEssMember.EEssTimeBalanceSkipOption timeBalSkip,
                             IEssMember.EEssShareOption shareOption)
                             throws com.essbase.api.base.EssException
Creates a child member.
Parameters:
name - The member name to create.
prevSibling - The previous sibling member. The new member will be placed after this member.
description - The member description.
consolidation - The unary consolidation type.
twoPass - true if two-pass calculation member.
expense - true if expense member.
conversion - The currency conversion type.
curCatOrName - The currency category or the currency name.
timeBalance - The Time balance option.
timeBalSkip - The Time balance skip option.
shareOption - The share option.
Returns:
The child member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createChildAttributeMember

IEssMember createChildAttributeMember(java.lang.String name,
                                      IEssDimension.EEssAttributeDataType attrDataType,
                                      IEssMember prevSibling)
                                      throws com.essbase.api.base.EssException
Creates a child attribute member.
Parameters:
name - The member name to create.
attrDataType - The attribute member data type.
prevSibling - The previous sibling member. The new member will be placed after this member.
Returns:
The child member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

sortChildren

void sortChildren(boolean ascending)
                  throws com.essbase.api.base.EssException
Sorts the children of this member.
Parameters:
ascending - true if sort type is ascending, false is descending.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getChildMembers

IEssIterator getChildMembers()
                             throws com.essbase.api.base.EssException
Gets the list of child members. This method inturn calls getChildMembers(false). This operation is allowed only on member objects obtained from open outline sequence.
Returns:
The child members (each of type IEssMember).
Throws:
com.essbase.api.base.EssException - if an error occurs.

getChildMembers

IEssIterator getChildMembers(boolean withAllProps)
                             throws com.essbase.api.base.EssException
Gets the list of child members.
Parameters:
withAllProps - true to get all the properties associated with the child members in one round trip. false to get the names alone (the rest of the properties will be fetched once the member object is accessed for any property other than the name). This operation is allowed only on member objects obtained from open outline sequence.
Returns:
The child members (each of type IEssMember).
Throws:
com.essbase.api.base.EssException - if an error occurs.

getRelatedMemberNames

java.lang.String[] getRelatedMemberNames()
                                         throws com.essbase.api.base.EssException
Gets the name of the parent, previous sibling, next sibling, first child.
Returns:
Array of 4 names. String[0] - parent member name, String[1] - previous sibling member name, String[2] - next sibling member name, String[3] - first child member name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

delete

void delete()
            throws com.essbase.api.base.EssException
Delete the member from the outline with ESS_VERIFY_ALL option.
Throws:
com.essbase.api.base.EssException - if an error occurs.

delete

void delete(short verifyType)
            throws com.essbase.api.base.EssException
Deletes the member from the outline.
Parameters:
verifyType - - Verification options are: 0 - IEssMember.ESS_VERIFY_ALL 1 - IEssMember.ESS_VERIFY_ORDER_INDEPENDENT 2 - IEssMember.ESS_VERIFY_ORDER_DEPENDENT 3 - IEssMember.ESS_VERIFY_DEFER 4 - IEssMember.ESS_VERIFY_NAMEONLY
Throws:
com.essbase.api.base.EssException - if an error occurs.

rename

void rename(java.lang.String newMbrName)
            throws com.essbase.api.base.EssException
Renames the member.
Parameters:
newMbrName - The new name for the member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getLastFormula

java.lang.String getLastFormula()
                                throws com.essbase.api.base.EssException
Deprecated. Since 11.1.1.1.00.
Gets the last member formula used to calculate the member.
Returns:
The member formula.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getFormula

java.lang.String getFormula()
                            throws com.essbase.api.base.EssException
Gets the member formula.
Returns:
The member formula.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setFormula

void setFormula(java.lang.String formula)
                throws com.essbase.api.base.EssException
Sets the member formula.
Parameters:
formula - The member formula.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteFormula

void deleteFormula()
                   throws com.essbase.api.base.EssException
Deletes the member formula.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAlias

java.lang.String getAlias(java.lang.String aliasTableName)
                          throws com.essbase.api.base.EssException
Gets the default member alias for this member in a specific alias table.
Parameters:
aliasTableName - The alias table to get the alias from. If this parameter is null, the default alias table is used.
Returns:
The default member alias.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setAlias

void setAlias(java.lang.String aliasTableName,
              java.lang.String alias)
              throws com.essbase.api.base.EssException
Sets the default member alias for this member in a specific alias table.
Parameters:
aliasTableName - The alias table to set the alias for. If this parameter is null, the default alias table is used.
alias - The default member alias.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteAlias

void deleteAlias(java.lang.String aliasTableName)
                 throws com.essbase.api.base.EssException
Deletes the default member alias for this member in a specific alias table.
Parameters:
aliasTableName - The alias table to delete the alias from. If this parameter is null, the default table is used.
Throws:
com.essbase.api.base.EssException - if an error occurs.

addAliasCombination

void addAliasCombination(java.lang.String aliasTableName,
                         java.lang.String alias,
                         java.lang.String mbrCombination)
                         throws com.essbase.api.base.EssException
Deprecated. This function is deprecated in 7.1 version.
Adds an alias combination to this member for a specific alias table.
Parameters:
aliasTableName - The alias table to add the combination to. If this parameter is null, the default alias table is used.
alias - The alias.
mbrCombination - The member combination to associate with the alias. This can be a cross-dimensional member list.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteAliasCombination

void deleteAliasCombination(java.lang.String aliasTableName,
                            java.lang.String alias)
                            throws com.essbase.api.base.EssException
Deprecated. This function is deprecated in 7.1 version.
Deletes an alias combination for this member in a specific alias table.
Parameters:
aliasTableName - The alias table to remove the combination from. If this parameter is null, the default alias table is used.
alias - The alias to remove.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAliasCombinations

java.lang.String[] getAliasCombinations(java.lang.String aliasTableName)
                                        throws com.essbase.api.base.EssException
Deprecated. This function is deprecated in 7.1 version.
Gets all the alias combinations for this member in a specific alias table.
Parameters:
aliasTableName - The alias table to retrieve the alias combinations from. If this parameter is null, the default alias table is used.
Returns:
The alias combinations. The first entry is the first alias, The next entry is the member combination for first alias, The next entry is the second alias and so on.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getUDAs

java.lang.String[] getUDAs()
                           throws com.essbase.api.base.EssException
Gets the User Defined Attributes of this member.
Returns:
The User Defined Attributes. null if there are no attributes.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createUDA

void createUDA(java.lang.String uda)
               throws com.essbase.api.base.EssException
Creates a User Defined Attribute for this member.
Parameters:
uda - The User Defined Attribute to create.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteUDA

void deleteUDA(java.lang.String uda)
               throws com.essbase.api.base.EssException
Deletes a User Defined Attribute for this member.
Parameters:
uda - The User Defined Attribute to delete.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isNameUnique

boolean isNameUnique()
                     throws com.essbase.api.base.EssException
Check to see if this member's name is unique within the outline this member belongs to.
Returns:
true if this member's name is unique, otherwise false.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getUniqueName

java.lang.String getUniqueName()
                               throws com.essbase.api.base.EssException
If this member’s name is not unique, it returns the minimum composed name, otherwise it returns the member name. It works in both outline edit and query modes.
Returns:
true if this member's name is unique, otherwise false.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setOriginalMemberName

void setOriginalMemberName(java.lang.String origMbrName)
                           throws com.essbase.api.base.EssException
This is to make this member as an extended shared member. To link this member to the original member, specify the name of the original member. This works only in outline edit mode (and not in query mode).
Parameters:
origMbrName - Original Member's name
Throws:
com.essbase.api.base.EssException - if an error occurs

getOriginalMemberName

java.lang.String getOriginalMemberName()
                                       throws com.essbase.api.base.EssException
If this member is a extended shared member, it returns its original member name. Otherwise will return null. This works in both outline edit and query modes.
Returns:
Original Member's Name if this is a extended shared member, else null.
Throws:
com.essbase.api.base.EssException - if an error occurs

getMemberId

java.lang.String getMemberId()
                             throws com.essbase.api.base.EssException
If there is a member ID for this member, then return it. Otherwise it will return null. This works in both outline edit and query modes.
Returns:
return member ID for member hMember if there is a member ID.
Throws:
com.essbase.api.base.EssException - if an error occurs

setMemberId

void setMemberId(java.lang.String memberID)
                 throws com.essbase.api.base.EssException
Assigns the given member ID to this member. This works only in outline edit mode (and not in query mode).
Parameters:
memberID - Member Id to be assigned
Throws:
com.essbase.api.base.EssException - if an error occurs

deleteMemberId

void deleteMemberId()
                    throws com.essbase.api.base.EssException
Delete member ID(if any) attached to this member. This works only in outline edit mode (and not in query mode).
Throws:
com.essbase.api.base.EssException - if an error occurs

isIndependentDim

boolean isIndependentDim()
                         throws com.essbase.api.base.EssException
Checks to see if this object represents an independent dimension.
Returns:
true if its an independent dimension.
Throws:
com.essbase.api.base.EssException - if an error occurs

setIndependentDim

void setIndependentDim(boolean independentDim)
                       throws com.essbase.api.base.EssException
Set the Dimension to either independent or dependent.
Parameters:
independentDim - Dimension state to indicate whether its independent.
Throws:
com.essbase.api.base.EssException - if an error occurs

getHierarchyType

IEssMember.EEssHierarchyType getHierarchyType()
                                              throws com.essbase.api.base.EssException
Returns the hierarchy type of this member.
Returns:
Hierarchy Type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setHierarchyType

void setHierarchyType(IEssMember.EEssHierarchyType hierType)
                      throws com.essbase.api.base.EssException
Sets the specified Hierarchy Type.
Parameters:
hierType - Hierarchy Type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDimensionSolveOrder

short getDimensionSolveOrder()
                             throws com.essbase.api.base.EssException
Returns the default solveOrder for all members which do not have their own Solve Order. Only the dimension member can have Dimension Solve Order.
Returns:
Dimension solve order number
Throws:
com.essbase.api.base.EssException - if an error occurs.

setDimensionSolveOrder

void setDimensionSolveOrder(short dimSolveOrder)
                            throws com.essbase.api.base.EssException
Sets the Dimension solve order number.
Parameters:
dimSolveOrder - Dimension Solve Order number.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getSolveOrder

short getSolveOrder()
                    throws com.essbase.api.base.EssException
Returns the SolveOrder number 0 to 127 that decides in which order dynamic member values are calculated.
Returns:
Solve Order number of this member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setSolveOrder

void setSolveOrder(short solveOrder)
                   throws com.essbase.api.base.EssException
Sets the SolveOrder number (Valid Range: 0 to 127) that decides in which order dynamic member values are calculated.
Parameters:
solveOrder - Solve Order number for this member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getMemberComment

java.lang.String getMemberComment()
                                  throws com.essbase.api.base.EssException
Gets the Extended Member Comment for a given member This operation is not allowed on member objects obtained using IEssCube.getMember(String mbrName) or IEssCubeView.memberSelection().
Returns:
Extended Member Comment for a member
Throws:
com.essbase.api.base.EssException - if an error occurs.

setMemberComment

void setMemberComment(java.lang.String comment)
                      throws com.essbase.api.base.EssException
Sets the Extended Member Comment
Parameters:
comment - Extended Member Comment to be sed for member
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAssociatedAttributes

IEssIterator getAssociatedAttributes()
                                     throws com.essbase.api.base.EssException
Gets all attribute members that are associated with a base member or dimension. This works only in outline edit mode (and not in query mode).
Returns:
The list of attribute members (each of type IEssMember).
Throws:
com.essbase.api.base.EssException - if an error occurs.

isMemberNameUniqueWithinDim

boolean isMemberNameUniqueWithinDim()
                                    throws com.essbase.api.base.EssException
Discovers if member names are all unique within a dimension.
Returns:
TRUE if the dimension queried contains no duplicate member names; FALSE otherwise.
Throws:
com.essbase.api.base.EssException

isMemberNameUniqueWithinDimAtGenLevel

boolean isMemberNameUniqueWithinDimAtGenLevel(boolean bGen,
                                              short sGenLevel)
                                              throws com.essbase.api.base.EssException
Discovers if all member names are unique within a dimension at the generation or level specified.
Parameters:
bGen - - If TRUE, usGenLevel is considered a generation number. If FALSE, usGenLevel is considered a level number.
sGenLevel - - generation or level number
Returns:
TRUE if the dimension queried contains duplicate member names at the generation or level specified; FALSE otherwise
Throws:
com.essbase.api.base.EssException

getCountOfDupMemberNameInDim

long getCountOfDupMemberNameInDim()
                                  throws com.essbase.api.base.EssException
Returns the number of members in a dimension whose names are duplicate in the outline opened in query mode
Returns:
The number of members with duplicate names (output).
Throws:
com.essbase.api.base.EssException

getAggregationLevelUsage

short getAggregationLevelUsage()
                               throws com.essbase.api.base.EssException
Returns the aggregation level usage of this member, the applied view selection properties on stored hierarchies. This function is applicable only to Release 9.3 or higher aggregate storage databases.
Returns:
aggregation level.
Throws:
com.essbase.api.base.EssException - if an error occurs.
See Also:
setAggregationLevelUsage(short)

setAggregationLevelUsage

void setAggregationLevelUsage(short aggLevel)
                              throws com.essbase.api.base.EssException
Sets the aggregation level usage of this member. Applies view selection properties to stored hierarchies. This function is applicable only to Release 9.3 or higher aggregate storage databases. Use this function to apply view selection properties to stored hierarchies to restrict Essbase from choosing certain levels for aggregation.
Parameters:
aggLevel - -aggregation level weightage. Values are: ESS_AGGLEVELUSAGE_NOTSET, ESS_AGGLEVELUSAGE_DEFAULT, ESS_AGGLEVELUSAGE_ALL, ESS_AGGLEVELUSAGE_NOAGGREGATION, ESS_AGGLEVELUSAGE_BOTTOMONLY, ESS_AGGLEVELUSAGE_TOPONLY, ESS_AGGLEVELUSAGE_BOTTOMTOP.
Throws:
com.essbase.api.base.EssException - if an error occurs.
See Also:
getAggregationLevelUsage()

isFlowType

boolean isFlowType()
                   throws com.essbase.api.base.EssException
Indicates that member is type Flow.
Returns:
true if its flow type member.
Throws:
com.essbase.api.base.EssException - if an error occurs

setFlowType

void setFlowType(boolean flow)
                 throws com.essbase.api.base.EssException
Set the member to type Flow.
Parameters:
flow - If true, indicates that member is to be type Flow.
Throws:
com.essbase.api.base.EssException - if an error occurs

getLinkedAttributeAttachLevel

short getLinkedAttributeAttachLevel()
                                    throws com.essbase.api.base.EssException
For every Linked value attribute (LVA) defined, there is an association level and an attachment level associated with the attribute dimension definition. This returns the This is supported in the Query mode (i.e., through IEssMemberSelection) only.
Returns:
Attachment level of the linked value attribute
Throws:
com.essbase.api.base.EssException - if an error occurs

getAttributeAssocLevel

short getAttributeAssocLevel()
                             throws com.essbase.api.base.EssException
For every Attribute dimension defined, there is an association level defined based on the base dimension Level its associated with. This method retrieves the association level of an attribute dimension (if this member represents an attribute dimension).
Returns:
Association Level of this Attribute Member.
Throws:
com.essbase.api.base.EssException - if an error occurs

getSmartList

IEssSmartList getSmartList()
                           throws com.essbase.api.base.EssException
Gets the associated smartlist instance. If no such smartlist exist. An EssException will be thrown.
Returns:
associated smartlist instance.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setSmartList

void setSmartList(IEssSmartList smartList)
                  throws com.essbase.api.base.EssException
Sets the specified smartlist for the given member. Also sets the member type to IEssMember.ESS_MEMBERTYPE_SMARTLIST.
Parameters:
smartList - - smartlist instance to be associated.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getMemberType

short getMemberType()
                    throws com.essbase.api.base.EssException
Gets the member type.
Returns:
memberType - Type of the outline member. It can be one of the values

IEssMember.ESS_MEMBERTYPE_NUMERIC Member type is a numeric

IEssMember.ESS_MEMBERTYPE_SMARTLIST Member type is textual and has an associated smartlist

IEssMember.ESS_MEMBERTYPE_DATE Member type is date typed

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

setMemberType

void setMemberType(short memberType)
                   throws com.essbase.api.base.EssException
Sets the member type.

setting the type to IEssMember.ESS_MEMBERTYPE_SMARTLIST is not allowed

To set member type to IEssMember.ESS_MEMBERTYPE_SMARTLIST use method setSmartList

If type is set to IEssMember.ESS_MEMBERTYPE_DATE, then the default date format will be yyyy-mm-dd

Parameters:
memberType - - Type of the outline member. It can be one of the values IEssMember.ESS_MEMBERTYPE_NUMERIC Member type is a numeric IEssMember.ESS_MEMBERTYPE_DATE Member type is date typed
Throws:
com.essbase.api.base.EssException - if an error occurs.

getFormatString

java.lang.String getFormatString()
                                 throws com.essbase.api.base.EssException
Gets the format String
Returns:
the format String associated with the member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setFormatString

void setFormatString(java.lang.String formatString)
                     throws com.essbase.api.base.EssException
Sets format string.
Parameters:
formatString - - format String to be set.
Throws:
com.essbase.api.base.EssException - if an error occurs.

Skip navigation links

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD