IHsvTreeInfo Interface Overview

The IHsvTreeInfo interface is implemented in all of the dimension objects listed in Table 9, HsvMetadata Type Library — Dimension Objects. This interface provides access to internal IDs and labels of dimension members, and also gets information about dimension hierarchies.

To assign IHsvTreeInfo object references, use the HsvMetadata object property for the applicable dimension; these properties are summarized in Table 10, HsvMetadata Object Properties. For an example of how to set IHsvTreeInfo object references, see IHsvTreeInfo Interface Methods.

The following table summarizes the IHsvTreeInfo interface’s methods.

Table 19. IHsvTreeInfo Interface Methods

Method

Description

EnumAllMemberIDs

Returns numeric IDs that identify all the members of a dimension.

EnumAllMemberLabels

Returns the labels of all the members of a dimension.

EnumAllParentAndChildIDs

Returns arrays of IDs that represent the parent-child relationships of a dimension’s members.

EnumAllParentAndChildLabels

Returns arrays that contain member labels and that represent the parent-child relationships of a dimension’s members.

EnumAncestors

Returns an array containing the member IDs of a given member’s ancestors.

EnumBaseMemberIDs

Returns an array containing the member IDs of a given parent’s base-level members. You can also use EnumBaseMemberIDs to get all of a dimension’s base-level members.

EnumDefaultAncestors

Returns the member IDs of a given member’s default ancestors.

EnumDefaultAncestorsLabels

Returns the labels of a given member’s default ancestors.

EnumDescendants

Returns an array containing the member IDs of a given member’s descendants.

EnumIDsOfChildren

Returns either the top members of a dimension hierarchy or the child members of a parent member.

EnumIDsOfIChildren

Returns children and the parent item of the requested children.

EnumMemberLists

Returns the names of the member lists for a dimension.

EnumMembers

Returns an array containing the member IDs of the dimension members in either the default dimension hierarchy or in a member list.

EnumMembers2

Returns an array containing the member IDs of the dimension members in either the default dimension hierarchy, a static member list, or a dynamic member list for given Scenario, Year, Period, and Entity dimension members.

EnumMembersWithAttribValue

Enumerates the attribute IDs and corresponding labels for a given attribute.

EnumParents

Returns an array containing the member IDs of a given member’s parent members.

EnumSortedIDsOfChildren

Returns an array containing the member IDs an Intercompany Partner dimension member’s children, with the members sorted according to the specified sorting criteria.

EnumSortedIDsofIChildren

Returns Sorted children and the parent item of the specified children.

EnumSortedMembers

Returns an array containing the member IDs of the Intercompany Partner dimension members in a member list, with the members sorted according to the specified sorting criteria.

Find

Returns the member IDs of those members of a member list with labels that match a search string. Each time a member matching the search criteria is found, the member ID of the member and the member ID of its parent are returned.

FindByDesc

Returns the member IDs of those members of a member list with descriptions that match a search string in a given language.

FindMatchingMembersFromHierarchy

Returns the member IDs of the members with labels that match a search string.

FindMatchingMembersFromHierarchyByDesc

Returns the member IDs of the members with descriptions in a given language that match a search string.

FindMatchingMembersFromHierarchyWildCard

Returns the member IDs of the members with labels or descriptions that match a search string; the search string can include wildcard characters.

GetAllPathsToMember

Returns an array of strings that represent the possible paths in a dimension’s hierarchy to a given member.

GetAttributeValue

Returns the value of a given member’s metadata attribute.

GetDefaultHierarchyPosition

Returns the default position of a member within a dimension’s hierarchy.

GetDefaultItemIDHierarchy

Returns an array containing the path of a dimension member and its ancestors. The array contains the member IDs of the members in this path.

GetDefaultMemberID

Returns the member ID of a dimension’s default member.

GetDefaultParent

Returns the member ID of a given dimension member’s default parent.

GetDefaultParentLabel

Returns the label of a given dimension member’s default parent.

GetDescription

Returns the description of a dimension member.

GetDisplayInfo

Returns the label and description of a dimension member.

GetDisplayInfoForSeveralItems

Returns arrays containing the labels and descriptions of dimension members.

GetItemGeneration

Returns the generation of a given member in the dimension hierarchy.

GetItemID

Returns the member ID of a dimension member.

GetItemIDQL

For internal use.

GetItemLevel

Returns the level of a given member in the dimension hierarchy.

GetLabel

Returns the label of a dimension member.

GetMemberListID

Returns the numeric ID of a member list.

GetMemberListName

Returns the name of a member list for which you have the ID number.

GetNumBaseMembers

Returns a count of the base-level members beneath a dimension member.

GetNumChildren

Returns the number of children that are one level beneath a dimension member in a dimension hierarchy.

GetNumDescendants

Returns the number of descendants beneath a member in a dimension’s hierarchy, given the member’s ID.

GetNumMembers

Returns the number of members in a dimension.

GetNumParents

Returns the number of parents for a dimension member, given the member’s ID.

GetQualifiedLabel

For internal use.

GetTreeCapabilities

Returns various properties of a dimension.

GetTreeName

Returns the name of the dimension to which the IHsvTreeInfo interface has been set.

GetTreeTimeStamp

Returns a timestamp that indicates when the dimension was last updated.

HasChildren

Indicates whether a dimension member has child members.

IsMemberABaseOf

Indicates whether a member is in a base-level position beneath another member in a dimension hierarchy.

IsMemberAChildOf

Indicates whether one member is a child of another member.

IsMemberADescendantOf

Indicates whether one member is a descendant beneath another member in a dimension hierarchy.

SortMembersBasedOnList

Filters and sorts member IDs, using the members in a member list as the filtering and sorting criteria. You can also filter and sort against a dimension’s default hierarchy instead of a member list.

TranslateAttributeValueForDisplay

Returns a String representation of a dimension member’s attribute. However, in cases where the attribute value is itself a dimension member, the member ID of the attribute value is returned instead of the member’s label.

For detailed descriptions of these methods, see IHsvTreeInfo Interface Methods.