Home > Class Reference > %SYS namespace > Inventory.Scan


persistent class Inventory.Scan extends %Library.Persistent, %XML.Adaptor

SQL Table Name: Inventory.Scan

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.

Property Inventory

Method Inventory


property Description as %String (MAXLEN = 512);
A description of the circumstances of this scan
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property EndTimeStamp as %TimeStamp;
The end time of this scan.
Property methods: EndTimeStampDisplayToLogical(), EndTimeStampGet(), EndTimeStampGetStored(), EndTimeStampIndexExists(), EndTimeStampIsValid(), EndTimeStampLogicalToDisplay(), EndTimeStampLogicalToXSD(), EndTimeStampNormalize(), EndTimeStampOdbcToLogical(), EndTimeStampSet(), EndTimeStampXSDToLogical()
property RootComponent as Component;
The Component that served as the origin of the scan.
Property methods: RootComponentGet(), RootComponentGetObject(), RootComponentGetObjectId(), RootComponentGetStored(), RootComponentGetSwizzled(), RootComponentIndexExists(), RootComponentIsValid(), RootComponentNewObject(), RootComponentSet(), RootComponentSetObject(), RootComponentSetObjectId(), RootComponentUnSwizzle()
property StartTimeStamp as %TimeStamp;
The start time of this scan.
Property methods: StartTimeStampDisplayToLogical(), StartTimeStampGet(), StartTimeStampGetStored(), StartTimeStampIndexExists(), StartTimeStampIsValid(), StartTimeStampLogicalToDisplay(), StartTimeStampLogicalToXSD(), StartTimeStampNormalize(), StartTimeStampOdbcToLogical(), StartTimeStampSet(), StartTimeStampXSDToLogical()


classmethod OpenByDescription(description As %String) as Scan [ Language = objectscript ]
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.

method WriteToFile(filename As %String) as %Status [ Language = objectscript ]
Writes the content of this scan to filename in %XML.Export format. Note that an existing file will be overwritten.

Inherited Methods


index (EndTimeStampIndex on EndTimeStamp);
Index methods: EndTimeStampIndexExists()
index (RootComponentIndex on RootComponent);
Index methods: RootComponentIndexExists()
index (StartTimeStampIndex on StartTimeStamp);
Index methods: StartTimeStampIndexExists()


Storage Model: Storage (Inventory.Scan)