HsvScenarios Object Overview

The HsvScenarios object provides access to some of the attributes of Scenario dimension members. Assign HsvScenarios object references with the Scenarios property; for more information, see Scenarios.

The following table lists the methods of the HsvScenarios object.

Table 17. HsvScenarios Object Methods

Method

Description

GetPhasedSubmissionStartYear

Returns the Phased Submission start year for the scenario.

EnumPhasedSubmissionStartYears

Returns and array of Scenario IDs and their corresponding Phased Submission start years.

GetDefaultFrequency

Returns the number that identifies the default frequency of a Scenario dimension member.

GetDefaultView

Returns the number that identifies the default view of a Scenario dimension member.

GetMaximumReviewLevel

Returns the value assigned to the MaximumReviewLevel attribute of a Scenario dimension member.

GetMissingDataZeroViewForAdjValues

Returns the member ID of the View dimension member that has been assigned as the ZeroViewForAdj attribute of a given Scenario dimension member.

GetMissingDataZeroViewForNonAdjValues

Returns the member ID of the View dimension member that has been assigned as the ZeroViewForNonadj attribute of a given Scenario dimension member.

GetSecurityClassID

Returns the ID of the security class that has been assigned to a scenario, given the scenario’s member ID.

GetUserDefined1

Returns the text stored in the UserDefined1 attribute of a Scenario dimension member.

GetUserDefined2

Returns the text stored in the UserDefined2 attribute of a Scenario dimension member.

GetUserDefined3

Returns the text stored in the UserDefined3 attribute of a Scenario dimension member.

IsConsolidateYTD

Indicates whether a given Scenario dimension member supports year-to-date consolidation.

IsPhasedSubmissionEnabledIndicates whether Phased Submissions is enabled for a given Scenario and Year.

SupportsAccountAllocations

For internal use.

SupportsEmailAlerting

Indicates whether email alerting is enabled for a given Scenario dimension member.

SupportsProcessFlow

Indicates whether Process Management is enabled for a given Scenario dimension member.

SupportsTargetSetting

For internal use.

SupportsTimePeriodAllocations

For internal use.

UsesLineItems

Indicates whether a Scenario dimension member supports line items.

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