Skip to main content


persistent class HS.Registry.Document.Slot extends %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_Registry_Document.Slot

Property Inventory

Method Inventory


Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.


relationship Classification as HS.Registry.Document.Classification (SELECTIVITY = ".0000667%") [ Inverse = Slots , Cardinality = one ];
Property methods: ClassificationGet(), ClassificationGetObject(), ClassificationGetObjectId(), ClassificationGetStored(), ClassificationGetSwizzled(), ClassificationIsValid(), ClassificationNewObject(), ClassificationOnDelete(), ClassificationRClose(), ClassificationRExec(), ClassificationRFetch(), ClassificationRelate(), ClassificationSQLCompute(), ClassificationSet(), ClassificationSetObject(), ClassificationSetObjectId(), ClassificationUnRelate(), ClassificationUnSwizzle()
relationship Document as HS.Registry.Document (SELECTIVITY = ".0000667%", XMLPROJECTION = "NONE") [ Inverse = Slots , Cardinality = one ];
Property methods: DocumentGet(), DocumentGetObject(), DocumentGetObjectId(), DocumentGetStored(), DocumentGetSwizzled(), DocumentIsValid(), DocumentNewObject(), DocumentOnDelete(), DocumentRClose(), DocumentRExec(), DocumentRFetch(), DocumentRelate(), DocumentSQLCompute(), DocumentSet(), DocumentSetObject(), DocumentSetObjectId(), DocumentUnRelate(), DocumentUnSwizzle()
property Name as %String (MAXLEN = 32000, SELECTIVITY = "10%");
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
relationship RegistryPackage as HS.Registry.Document.RegistryPackage (SELECTIVITY = ".0000667%", XMLPROJECTION = "NONE") [ Inverse = Slots , Cardinality = one ];
Property methods: RegistryPackageGet(), RegistryPackageGetObject(), RegistryPackageGetObjectId(), RegistryPackageGetStored(), RegistryPackageGetSwizzled(), RegistryPackageIsValid(), RegistryPackageNewObject(), RegistryPackageOnDelete(), RegistryPackageRClose(), RegistryPackageRExec(), RegistryPackageRFetch(), RegistryPackageRelate(), RegistryPackageSQLCompute(), RegistryPackageSet(), RegistryPackageSetObject(), RegistryPackageSetObjectId(), RegistryPackageUnRelate(), RegistryPackageUnSwizzle()
property ValueList as list of %String (MAXLEN = 32000, SELECTIVITY = "20%", STORAGEDEFAULT = "array");
Property methods: ValueListBuildValueArray(), ValueListCollectionToDisplay(), ValueListCollectionToOdbc(), ValueListDisplayToCollection(), ValueListDisplayToLogical(), ValueListGet(), ValueListGetObject(), ValueListGetObjectId(), ValueListGetStored(), ValueListGetSwizzled(), ValueListIsValid(), ValueListLogicalToDisplay(), ValueListLogicalToOdbc(), ValueListNormalize(), ValueListOdbcToCollection(), ValueListSet(), ValueListSetObject(), ValueListSetObjectId()


classmethod ValueForNameDocument(pName="", pDocument="") as %String
used for single value entries (serviceStartTime ...)
classmethod ValueForNameRegistryPackage(pName="", pRegistryPackage="") as %String


index (ClassificationIndex on Classification);
Index methods: ClassificationIndexExists()
index (DocumentIndex on Document);
Index methods: DocumentIndexExists()
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (NameDocumentIndex on Name,Document);
Index methods: NameDocumentIndexExists()
index (RegistryPackageDocumentIndex on RegistryPackage,Document);
Index methods: RegistryPackageDocumentIndexExists()
index (ValueListIndex on ValueList(ELEMENTS):SQLUPPER(450),ValueList(KEYS));
Index only the first 450 characters of the ValueList value

Inherited Members

Inherited Methods


Storage Model: Storage (HS.Registry.Document.Slot)


Storage Model: Storage (HS.Registry.Document.Slot)

FeedbackOpens in a new tab