HsvJournals Object Overview

The HsvJournals object is used to manage periods and to get internal IDs of journals and templates.

The HsvJournals object is a child of the HsvSession object. Use HsvSession’s Journals property to assign HsvJournals object references as shown in the following example:

  Dim cHsvJournals As HsvJournals
  Set cHsvJournals = cHsvSession.Journals

The following table lists the HsvJournals object’s methods.

Table 23. HsvJournals Object Methods

Method

Description

ClosePeriod

Closes a period, meaning that journals can no longer be posted for the period.

GetItemID

Returns the internal ID of a journal. Use GetItemID with the IHsvJournalsEx interface methods that take journal IDs as arguments.

GetJournalTemplateItemID

Returns the internal ID of a template. Use GetJournalTemplateItemID with the IHsvJournalsEx interface methods that take template IDs as arguments.

GetPeriodStatusList

Returns a two-dimensional array that indicates whether the periods for a scenario and year are opened, unopened, or closed.

IsPeriodOpen

Indicates whether a period is open.

OpenPeriod

Opens a period, enabling users to post journals to the period.

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