HsvSession Type Library Overview
The HsvSession type library contains one object, the HsvSession object. The HsvSession object provides properties for accessing subordinate objects, such as the objects used for accessing metadata, data, journals, security, and so on. The HsvSession object also provides a method for instantiating objects such as server-side Application Components (ACMs) on application servers.
HsvSession object references are returned by the OpenApplication methods of the HsxClient and HsxClientUI objects. For details and an example, see OpenApplication.
The following table lists the properties of the HsvSession object, and Table 8 lists the object’s methods.
Table 7. HsvSession Object Properties
Property | Description |
|---|
Calculate | Returns an HsvCalculate object reference. |
Data | Returns an HsvData object reference. |
ICM | Returns an object reference to the HsvICM object or the IHsvAdminICM interface. |
Journals | Returns an HsvJournals, IHsvJournalsEx, or IHsvJournalsReport object reference. |
Metadata | Returns an HsvMetadata object reference. |
ProcessFlow | Returns an HsvProcessFlow object reference. |
Reports | Returns an HsvReports object reference. |
Security | Returns an HsvSecurityAccess or IHsvDataSecurity object reference. |
SystemInfo | Returns an HsvSystemInfo object reference. |
The HsvSession object also contains the following methods.
Table 8. HsvSession Object Methods
Method | Description |
|---|
CreateObject | Instantiates an object on the application server on which an application has been opened. Use CreateObject to instantiate server-side objects that you develop. |
GetLicenseExpirationStatus | Deprecated. |
HasSystemChanged | Indicates whether an application’s system information has changed in a way that might require a consolidation, calculation, or translation to be run. For example, HasSystemChanged returns TRUE if a metadata file has been loaded since the last consolidation. |
HasUserStatusChanged | Indicates whether the connected user has been logged off by an administrator. |
IsBusy | For internal use. |
IsRunningTasks | For internal use. |
LockMetadataLoadWithSystemChangeCheck | For internal use. |
UnlockMetadataLoad | For internal use. |
For detailed descriptions of these properties and methods, see HsvSession Type Library.