HsvEntities Object Overview

The HsvEntities object provides access to some of the attributes of Entity dimension members. Assign HsvEntities object references with the Entities property; for more information, see Entities.

The following table lists the methods of the HsvEntities object.

Table 14. HsvEntities Object Methods

Method

Description

GetAllowAdjustments

Returns a Boolean that indicates whether an entity allows journal entries.

GetAllowAdjustmentsFromChildren

Returns a Boolean that indicates whether an entity allows journal postings from its children.

GetDefaultValueID

Returns the member ID of the Value dimension member that represents an entity’s default currency.

GetHoldingCompany

Returns the member ID of an entity’s HoldingCompany attribute.

GetSecurityAsPartnerID

Returns the value assigned to the SecurityAsPartner attribute of an Entity dimension member.

GetSecurityClassID

Returns the ID number of an entity’s security class.

GetUserDefined1

Returns the value that has been defined for an entity’s UserDefined1 attribute.

GetUserDefined2

Returns the value that has been defined for an entity’s UserDefined2 attribute.

GetUserDefined3

Returns the value that has been defined for an entity’s UserDefined3 attribute.

IsChild

Indicates whether an entity is a child of another entity.

IsDescendant

Returns a Boolean that indicates whether an entity is a descendant of another entity.

IsICP

Returns a Boolean that indicates whether an entity is an intercompany entity.

IsOrgByPeriodFilteringOn

Returns the current state of organization-by-period filtering.

IsSecurityAsPartnerEnabled

Indicates whether metadata security using entities’ SecurityAsPartner attributes is enabled.

For detailed descriptions of these methods, see HsvEntities Object Methods.