Inventory.Scan

Class Inventory.Scan Extends (%Persistent, %XML.Adaptor) [ Inheritance = right ]

Scan objects represent the results of scanning the installation and examining its components. Different types of component (e.g., routines, databases, files) are represented by different subclasses of the Component class. Components can contain subcomponents. Components are scanned recursively, and the result is a tree of objects.

The tree is rooted in the RootComponent property of the scan.

Scan objects also record the start and end times of the scan, as well as a text description, which is not requried to be unique.

Properties

Description

Property Description As %String(MAXLEN = 512);

A description of the circumstances of this scan

EndTimeStamp

Property EndTimeStamp As %TimeStamp;

The end time of this scan.

RootComponent

Property RootComponent As Component;

The Component that served as the origin of the scan.

StartTimeStamp

Property StartTimeStamp As %TimeStamp;

The start time of this scan.

Methods

OpenByDescription

ClassMethod OpenByDescription(description As %String) As Scan

Opens a previously saved Scan object with a Description of description.

If more than one Scan has the given description, returns the first one found.

Returns "" if no Scan found.

WriteToFile

Method WriteToFile(filename As %String) As %Status

Writes the content of this scan to filename in %XML.Export format. Note that an existing file will be overwritten.