|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssMember interface. There are 3 ways to get the IEssMember object depending on your need: 1. By performing a member selection query using IEssMemberSelection interface, 2. By opening the cube outline and getting the members, 3. Using the IEssCube.getMember().
Depending on the way the IEssMemberObject is created certain methods in the interface will not be relevant and will throw appropriate exception. If IEssMember is obtained using IEssCube.getMember, then only the following methods will work and the rest will throw exception: getName, getDescription, isDimensionRootMember, getLevelNumber, getGenerationNumber, getConsolidationType, getDimensionName, getParentMemberName, getFirstChildMemberName, getPreviousSiblingMemberName, getNextSiblingMemberName, getMemberNumber, getDimensionNumber.
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.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 inherited from class com.essbase.api.base.IEssProperties |
IEssProperties.EEssPropertyMode |
Field Summary | |
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_GENERATION_NUMBER
|
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_TIME_BALANCE_OPTION
|
static int |
PROP_TIME_BALANCE_SKIP_OPTION
|
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. |
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 |
deleteUDA(java.lang.String uda)
Deletes a User Defined Attribute for this member. |
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. |
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. |
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. |
IEssDimension.EEssDimensionStorageCategory |
getDimensionStorageCategory()
Gets the dimension storage category. |
java.lang.String |
getFirstChildMemberName()
Deprecated. |
java.lang.String |
getFormula()
Gets the member formula. |
int |
getGenerationNumber()
Gets the level of the generation in the outline. |
java.lang.String |
getLastFormula()
Gets the last member formula used to calculate the member. |
int |
getLevelNumber()
Gets the level of the member in the outline. |
int |
getMemberNumber()
Gets the member number (The position of the member starting from bottom left in the dimension hierarchy). |
java.lang.String |
getName()
Gets the member name. |
java.lang.String |
getNextSiblingMemberName()
Deprecated. |
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. |
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. |
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 |
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 |
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)
Gets 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)
Gets the currency conversion type. |
void |
setDescription(java.lang.String description)
Sets the member description. |
void |
setExpenseMember(boolean expense)
Sets if expense member. |
void |
setFormula(java.lang.String formula)
Sets the member formula. |
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 |
setTimeBalanceOption(IEssMember.EEssTimeBalanceOption timeBalance)
Gets the time balance option. |
void |
setTimeBalanceSkipOption(IEssMember.EEssTimeBalanceSkipOption timeBalSkip)
Gets 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 |
public static final int PROP_NAME
public static final int PROP_DESCRIPTION
public static final int PROP_IS_DIMENSION_ROOT
public static final int PROP_LEVEL_NUMBER
public static final int PROP_GENERATION_NUMBER
public static final int PROP_CONSOLIDATION_TYPE
public static final int PROP_IS_TWO_PASS_CALC_MEMBER
public static final int PROP_IS_EXPENSE_MEMBER
public static final int PROP_CURRENCY_CONVERSION_TYPE
public static final int PROP_CURRENCY_CATEGORY_OR_NAME
public static final int PROP_TIME_BALANCE_OPTION
public static final int PROP_TIME_BALANCE_SKIP_OPTION
public static final int PROP_SHARE_OPTION
public static final int PROP_CHILD_COUNT
public static final int PROP_IS_ATTRIBUTES_ASSOCIATED
public static final int PROP_ATTRIBUTE_VALUE
public static final int PROP_DIMENSION_NAME
public static final int s_countProperties
public static final java.lang.String[] s_propNames
public static final IEssValueAny.EEssDataType[] s_propDataTypes
public static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
public java.lang.String getName() throws EssException
getName
in interface IEssExtendedObject
EssException
- if an error occurs.public java.lang.String getDescription() throws EssException
EssException
- if an error occurs.public void setDescription(java.lang.String description) throws EssException
description
- The member description.
EssException
- if an error occurs.public boolean isDimensionRootMember() throws EssException
EssException
- if an error occurs.public int getLevelNumber() throws EssException
EssException
- if an error occurs.public int getGenerationNumber() throws EssException
EssException
- if an error occurs.public IEssMember.EEssConsolidationType getConsolidationType() throws EssException
EssException
- if an error occurs.public void setConsolidationType(IEssMember.EEssConsolidationType consolidation) throws EssException
consolidation
- The unary consolidation type.
EssException
- if an error occurs.public boolean isTwoPassCalculationMember() throws EssException
EssException
- if an error occurs.public void setTwoPassCalculationMember(boolean twoPass) throws EssException
twoPass
- true if two-pass calculation member.
EssException
- if an error occurs.public boolean isExpenseMember() throws EssException
EssException
- if an error occurs.public void setExpenseMember(boolean expense) throws EssException
expense
- true if expense member.
EssException
- if an error occurs.public IEssMember.EEssCurrencyConversionType getCurrencyConversionType() throws EssException
EssException
- if an error occurs.public void setCurrencyConversionType(IEssMember.EEssCurrencyConversionType conversion) throws EssException
conversion
- The currency conversion type.
EssException
- if an error occurs.public java.lang.String getCurrencyCategoryOrName() throws EssException
EssException
- if an error occurs.public void setCurrencyCategoryOrName(java.lang.String curCatOrName) throws EssException
curCatOrName
- The currency category or the currency name.
EssException
- if an error occurs.public IEssMember.EEssTimeBalanceOption getTimeBalanceOption() throws EssException
EssException
- if an error occurs.public void setTimeBalanceOption(IEssMember.EEssTimeBalanceOption timeBalance) throws EssException
timeBalance
- The time balance option.
EssException
- if an error occurs.public IEssMember.EEssTimeBalanceSkipOption getTimeBalanceSkipOption() throws EssException
EssException
- if an error occurs.public void setTimeBalanceSkipOption(IEssMember.EEssTimeBalanceSkipOption timeBalSkip) throws EssException
timeBalSkip
- The time balance skip option.
EssException
- if an error occurs.public IEssMember.EEssShareOption getShareOption() throws EssException
EssException
- if an error occurs.public void setShareOption(IEssMember.EEssShareOption share) throws EssException
share
- The share option.
EssException
- if an error occurs.public IEssDimension.EEssDimensionCategory getDimensionCategory() throws EssException
EssException
- if an error occurs.public IEssDimension.EEssDimensionStorageCategory getDimensionStorageCategory() throws EssException
EssException
- if an error occurs.public IEssDimension.EEssAttributeDataType getAttributeMemberDataType() throws EssException
EssException
- if an error occurs.public void setAttributeMemberDataType(IEssDimension.EEssAttributeDataType attrMbrDataType) throws EssException
attrMbrDataType
- The attribute member data type.
EssException
- if an error occurs.public int getChildCount() throws EssException
EssException
- if an error occurs.public boolean isAttributesAssociated() throws EssException
EssException
- if an error occurs.public IEssValueAny getAttributeValue() throws EssException
EssException
- if an error occurs.public java.lang.String getDimensionName() throws EssException
EssException
- if an error occurs.public java.lang.String getParentMemberName() throws EssException
EssException
- if an error occurs.public java.lang.String getFirstChildMemberName() throws EssException
EssException
- if an error occurs.public java.lang.String getPreviousSiblingMemberName() throws EssException
EssException
- if an error occurs.public java.lang.String getNextSiblingMemberName() throws EssException
EssException
- if an error occurs.public int getMemberNumber() throws EssException
EssException
- if an error occurs.public int getDimensionNumber() throws EssException
EssException
- if an error occurs.public boolean isRelationalDescendantPresent() throws EssException
EssException
- if an error occurs.public void setRelationalDescendantPresent(boolean relDesc) throws EssException
relDesc
- true if relational descendant is present.
EssException
- if an error occurs.public boolean isRelationalPartitionEnabled() throws EssException
EssException
- if an error occurs.public void setRelationalPartitionEnabled(boolean relPartEnabled) throws EssException
relPartEnabled
- true if relational partition is enabled.
EssException
- if an error occurs.public void refreshPropertyValues() throws EssException
refreshPropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void updatePropertyValues() throws EssException
updatePropertyValues
in interface IEssProperties
EssException
- if an error occurs.public IEssMember createChildMember(java.lang.String name) throws EssException
name
- The member name to create.
EssException
- if an error occurs.public IEssMember createChildMember(java.lang.String name, IEssMember prevSibling) throws EssException
name
- The member name to create.prevSibling
- The previous sibling member. The new member will be
placed after this member.
EssException
- if an error occurs.public IEssMember createChildMember(java.lang.String name, IEssMember prevSibling, IEssMember.EEssShareOption shareOption) throws EssException
name
- The member name to create.prevSibling
- The previous sibling member. The new member will be
placed after this member.shareOption
- The share option.
EssException
- if an error occurs.public 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 EssException
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.
EssException
- if an error occurs.public IEssMember createChildAttributeMember(java.lang.String name, IEssDimension.EEssAttributeDataType attrDataType, IEssMember prevSibling) throws EssException
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.
EssException
- if an error occurs.public void sortChildren(boolean ascending) throws EssException
ascending
- true if sort type is ascending, false is descending.
EssException
- if an error occurs.public IEssIterator getChildMembers() throws EssException
EssException
- if an error occurs.public IEssIterator getChildMembers(boolean withAllProps) throws EssException
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).
EssException
- if an error occurs.public java.lang.String[] getRelatedMemberNames() throws EssException
EssException
- if an error occurs.public void delete() throws EssException
EssException
- if an error occurs.public void rename(java.lang.String newMbrName) throws EssException
newMbrName
- The new name for the member.
EssException
- if an error occurs.public java.lang.String getLastFormula() throws EssException
EssException
- if an error occurs.public java.lang.String getFormula() throws EssException
EssException
- if an error occurs.public void setFormula(java.lang.String formula) throws EssException
formula
- The member formula.
EssException
- if an error occurs.public void deleteFormula() throws EssException
EssException
- if an error occurs.public java.lang.String getAlias(java.lang.String aliasTablename) throws EssException
EssException
- if an error occurs.public void setAlias(java.lang.String aliasTablename, java.lang.String alias) throws EssException
alias
- The default member alias.
EssException
- if an error occurs.public void deleteAlias(java.lang.String aliasTablename) throws EssException
EssException
- if an error occurs.public void addAliasCombination(java.lang.String aliasTableName, java.lang.String alias, java.lang.String mbrCombination) throws EssException
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.
EssException
- if an error occurs.public void deleteAliasCombination(java.lang.String aliasTableName, java.lang.String alias) throws EssException
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.
EssException
- if an error occurs.public java.lang.String[] getAliasCombinations(java.lang.String aliasTableName) throws EssException
aliasTableName
- The alias table to retrieve the alias combinations
from. If this parameter is null, the default alias table is used.
EssException
- if an error occurs.public java.lang.String[] getUDAs() throws EssException
EssException
- if an error occurs.public void createUDA(java.lang.String uda) throws EssException
uda
- The User Defined Attribute to create.
EssException
- if an error occurs.public void deleteUDA(java.lang.String uda) throws EssException
uda
- The User Defined Attribute to delete.
EssException
- if an error occurs.public IEssIterator getAssociatedAttributes() throws EssException
EssException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |