HsvMetadata Type Library Overview
The HsvMetadata type library contains several objects. The top-level object in this type library is the HsvMetadata object, which is a child object of the HsvSession object. The HsvMetadata object has several child objects, and contains properties that return object references to these objects. The HsvMetadata object also contains methods for extracting metadata and for returning various types of metadata-related information.
Most of the HsvMetadata object’s child objects represent the Financial Management dimensions; these dimension objects are listed in Table 9. The default interface for a dimension object contains the methods, if any, that specifically apply to the dimension. For example, the HsvAccounts object’s default interface contains methods that return attributes of Account dimension members.
In addition, each dimension object implements the IHsvTreeInfo interface. The IHsvTreeInfo interface gets IDs and labels of dimension members, as well as parent-child information for Entity dimension members.
The HsvMetadata type library also contains the HsvCurrencies object, which represents an application’s currencies.
The following table lists the dimension-related objects in the HsvMetadata type library.
Table 9. HsvMetadata Type Library — Dimension Objects
Object | Description |
|---|
HsvAccounts | Returns attributes of Account dimension members, and implements the IHsvTreeInfo interface for the Account dimension. |
HsvCustom | Returns attributes of the four Custom dimensions, and implements the IHsvTreeInfo interface for the Custom dimensions. |
HsvEntities | Returns attributes of Entity dimension members, and implements the IHsvTreeInfo interface for the Entity dimension. |
HsvICPs | Implements the IHsvTreeInfo interface for the Intercompany Partner dimension. |
HsvPeriods | Returns information about periods and frequencies, and implements the IHsvTreeInfo interface for the Period dimension. |
HsvScenarios | Returns attributes of Scenario dimension members, and implements the IHsvTreeInfo interface for the Scenario dimension. |
HsvValues | Implements the IHsvTreeInfo interface for the Value dimension. |
HsvViews | Implements the IHsvTreeInfo interface for the View dimension. |
HsvYears | Provides a method that returns an application’s valid range of years, and implements the IHsvTreeInfo interface for the Year dimension. |
Note: | The default interface for these objects is simply the object name prefixed with I; for example, the default interface for HsvAccounts is the IHsvAccounts interface. This is an irrelevant consideration for Visual Basic, but applies to other languages such as C++. |