Home > Class Reference > HSLIB namespace > HS.Registry.Document.ExternalIdentifier

HS.Registry.Document.ExternalIdentifier

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

SQL Table Name: HS_Registry_Document.ExternalIdentifier

Property Inventory

Method Inventory

Parameters

parameter XMLIGNOREINVALIDTAG = 1;
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.

Properties

property Attributes as array of %String (MAXLEN = 32000, STORAGEDEFAULT = "array", XMLNAME = "Attributes", XMLPROJECTION = "ELEMENT");
Property methods: AttributesBuildValueArray(), AttributesCollectionToDisplay(), AttributesCollectionToOdbc(), AttributesDisplayToCollection(), AttributesDisplayToLogical(), AttributesGet(), AttributesGetObject(), AttributesGetObjectId(), AttributesGetStored(), AttributesGetSwizzled(), AttributesIsValid(), AttributesLogicalToDisplay(), AttributesLogicalToOdbc(), AttributesNormalize(), AttributesOdbcToCollection(), AttributesSet(), AttributesSetObject(), AttributesSetObjectId()
property Classifications as list of HS.Registry.Document.Classification (XMLNAME = "Classification", XMLPROJECTION = "ELEMENT");
Property methods: ClassificationsBuildValueArray(), ClassificationsCollectionToDisplay(), ClassificationsCollectionToOdbc(), ClassificationsDisplayToCollection(), ClassificationsGet(), ClassificationsGetObject(), ClassificationsGetObjectId(), ClassificationsGetStored(), ClassificationsGetSwizzled(), ClassificationsIsValid(), ClassificationsOdbcToCollection(), ClassificationsSet(), ClassificationsSetObject(), ClassificationsSetObjectId()
property Comments as HS.Registry.Document.Type.ValueType (SELECTIVITY = "99%", XMLNAME = "Comments", XMLPROJECTION = "ELEMENT");
Property methods: CommentsGet(), CommentsGetObject(), CommentsGetObjectId(), CommentsGetStored(), CommentsGetSwizzled(), CommentsIsEmpty(), CommentsIsValid(), CommentsNewObject(), CommentsSet(), CommentsSetObject(), CommentsSetObjectId(), CommentsUnSwizzle()
property Description as list of HS.Registry.Document.Type.ValueType (SELECTIVITY = "99%", XMLNAME = "Description", XMLPROJECTION = "ELEMENT");
Property methods: DescriptionBuildValueArray(), DescriptionCollectionToDisplay(), DescriptionCollectionToOdbc(), DescriptionDisplayToCollection(), DescriptionGet(), DescriptionGetObject(), DescriptionGetObjectId(), DescriptionGetStored(), DescriptionGetSwizzled(), DescriptionIsValid(), DescriptionOdbcToCollection(), DescriptionSet(), DescriptionSetObject(), DescriptionSetObjectId()
property IID as %String (MAXLEN = 256, SELECTIVITY = 1, XMLNAME = "id", XMLPROJECTION = "ATTRIBUTE");
Property methods: IIDDisplayToLogical(), IIDGet(), IIDGetStored(), IIDIndexCheck(), IIDIndexCheckUnique(), IIDIndexDelete(), IIDIndexExists(), IIDIndexOpen(), IIDIndexSQLCheckUnique(), IIDIndexSQLExists(), IIDIndexSQLFindPKeyByConstraint(), IIDIndexSQLFindRowIDByConstraint(), IIDIsValid(), IIDLogicalToDisplay(), IIDLogicalToOdbc(), IIDNormalize(), IIDSet()
property IdentificationScheme as %String);
Property methods: IdentificationSchemeDisplayToLogical(), IdentificationSchemeGet(), IdentificationSchemeGetStored(), IdentificationSchemeIsValid(), IdentificationSchemeLogicalToDisplay(), IdentificationSchemeLogicalToOdbc(), IdentificationSchemeNormalize(), IdentificationSchemeSet()
property IdentificationValue as %String (MAXLEN = 255, SELECTIVITY = ".0044%");
Property methods: IdentificationValueDisplayToLogical(), IdentificationValueGet(), IdentificationValueGetStored(), IdentificationValueIsValid(), IdentificationValueLogicalToDisplay(), IdentificationValueLogicalToOdbc(), IdentificationValueNormalize(), IdentificationValueSet()
property Name as list of HS.Registry.Document.Type.ValueType (SELECTIVITY = "20%", XMLNAME = "Name", XMLPROJECTION = "ELEMENT");
Property methods: NameBuildValueArray(), NameCollectionToDisplay(), NameCollectionToOdbc(), NameDisplayToCollection(), NameGet(), NameGetObject(), NameGetObjectId(), NameGetStored(), NameGetSwizzled(), NameIsValid(), NameOdbcToCollection(), NameSet(), NameSetObject(), NameSetObjectId()
property RegistryObject as %String);
Property methods: RegistryObjectDisplayToLogical(), RegistryObjectGet(), RegistryObjectGetStored(), RegistryObjectIsValid(), RegistryObjectLogicalToDisplay(), RegistryObjectLogicalToOdbc(), RegistryObjectNormalize(), RegistryObjectSet()
property Slots as list of HS.Registry.Document.Slot (SELECTIVITY = ".04%", XMLNAME = "Slot", XMLPROJECTION = "ELEMENT");
Property methods: SlotsBuildValueArray(), SlotsCollectionToDisplay(), SlotsCollectionToOdbc(), SlotsDisplayToCollection(), SlotsGet(), SlotsGetObject(), SlotsGetObjectId(), SlotsGetStored(), SlotsGetSwizzled(), SlotsIsValid(), SlotsOdbcToCollection(), SlotsSet(), SlotsSetObject(), SlotsSetObjectId()
property Title as HS.Registry.Document.Type.ValueType (SELECTIVITY = "20%", XMLNAME = "Title", XMLPROJECTION = "ELEMENT");
Property methods: TitleGet(), TitleGetObject(), TitleGetObjectId(), TitleGetStored(), TitleGetSwizzled(), TitleIsEmpty(), TitleIsValid(), TitleNewObject(), TitleSet(), TitleSetObject(), TitleSetObjectId(), TitleUnSwizzle()

Methods

classmethod %OnDelete(oid As %ObjectIdentity) as %Status [ Language = objectscript ]
This callback method is invoked by the %Delete() method to provide notification that the object specified by oid is being deleted.

If this method returns an error then the object will not be deleted. [Previously private]

Indexes

index (AttributesIndex on Attributes(ELEMENTS),Attributes(KEYS));
index (IIDIndex on IID) [Unique];
Index methods: IIDIndexCheck(), IIDIndexCheckUnique(), IIDIndexDelete(), IIDIndexExists(), IIDIndexOpen(), IIDIndexSQLCheckUnique(), IIDIndexSQLExists(), IIDIndexSQLFindPKeyByConstraint(), IIDIndexSQLFindRowIDByConstraint()
index (IdentificationSchemeIndex on IdentificationScheme) [Type = bitmap];
index (ValueIndex on IdentificationValue);
Index methods: ValueIndexExists()

Inherited Members

Inherited Methods

Storage

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

^HS.Registry.DocExternalIdD(ID,"Attributes",n)
=
Attributes(n)

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

^HS.Registry.DocExternalIdD(ID,"Comments",n)
=
Comments(n)

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

^HS.Registry.DocExternalIdD(ID)
=
%%CLASSNAME
IID
RegistryObject
IdentificationScheme
IdentificationValue
Classifications
Slots
Name
Description
Title
FeedbackOpens in a new window