Home > Class Reference > HSLIB namespace > HS.Message.XMLMessage


persistent class HS.Message.XMLMessage extends %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_Message.XMLMessage

Property Inventory

Method Inventory


parameter FOUNDATION = 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 = inputonly;
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.


property AdditionalInfo as array of HS.Types.AdditionalInfoItem;
Property methods: AdditionalInfoBuildValueArray(), AdditionalInfoCollectionToDisplay(), AdditionalInfoCollectionToOdbc(), AdditionalInfoDisplayToCollection(), AdditionalInfoDisplayToLogical(), AdditionalInfoGet(), AdditionalInfoGetObject(), AdditionalInfoGetObjectId(), AdditionalInfoGetStored(), AdditionalInfoGetSwizzled(), AdditionalInfoIsValid(), AdditionalInfoLogicalToDisplay(), AdditionalInfoLogicalToOdbc(), AdditionalInfoNormalize(), AdditionalInfoOdbcToCollection(), AdditionalInfoSet(), AdditionalInfoSetObject(), AdditionalInfoSetObjectId()
property ContentStream as %Stream.GlobalCharacter (CONTENT = "MIXED");
XML Content Stream, for cases > 3.8MB
Property methods: ContentStreamDelete(), ContentStreamGet(), ContentStreamGetObject(), ContentStreamGetObjectId(), ContentStreamGetStored(), ContentStreamGetSwizzled(), ContentStreamIsValid(), ContentStreamNewObject(), ContentStreamOid(), ContentStreamOpen(), ContentStreamSet(), ContentStreamSetObject(), ContentStreamSetObjectId(), ContentStreamUnSwizzle()
property CustomAuditInfo as array of %String);
Data passed in here will be copied to CustomPairs when audited
Property methods: CustomAuditInfoBuildValueArray(), CustomAuditInfoCollectionToDisplay(), CustomAuditInfoCollectionToOdbc(), CustomAuditInfoDisplayToCollection(), CustomAuditInfoDisplayToLogical(), CustomAuditInfoGet(), CustomAuditInfoGetObject(), CustomAuditInfoGetObjectId(), CustomAuditInfoGetStored(), CustomAuditInfoGetSwizzled(), CustomAuditInfoIsValid(), CustomAuditInfoLogicalToDisplay(), CustomAuditInfoLogicalToOdbc(), CustomAuditInfoNormalize(), CustomAuditInfoOdbcToCollection(), CustomAuditInfoSet(), CustomAuditInfoSetObject(), CustomAuditInfoSetObjectId()
property DocType as %String);
Property methods: DocTypeDisplayToLogical(), DocTypeGet(), DocTypeGetStored(), DocTypeIsValid(), DocTypeLogicalToDisplay(), DocTypeLogicalToOdbc(), DocTypeNormalize(), DocTypeSet()
property Name as %String;
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property SAMLData as HS.IHE.XUA.SAMLData;
Contains SAML user / rhio / token
Property methods: SAMLDataGet(), SAMLDataGetObject(), SAMLDataGetObjectId(), SAMLDataGetStored(), SAMLDataGetSwizzled(), SAMLDataIsEmpty(), SAMLDataIsValid(), SAMLDataNewObject(), SAMLDataSet(), SAMLDataSetObject(), SAMLDataSetObjectId(), SAMLDataUnSwizzle()
property SOAPFault as %Binary);
Property methods: SOAPFaultGet(), SOAPFaultGetStored(), SOAPFaultIsValid(), SOAPFaultLogicalToXSD(), SOAPFaultSet(), SOAPFaultXSDToLogical()
property StreamCollection as list of HS.IHE.Common.Messages.MIMEAttachment;
Used to handle soap messages with attachments
Property methods: StreamCollectionBuildValueArray(), StreamCollectionCollectionToDisplay(), StreamCollectionCollectionToOdbc(), StreamCollectionDisplayToCollection(), StreamCollectionGet(), StreamCollectionGetObject(), StreamCollectionGetObjectId(), StreamCollectionGetStored(), StreamCollectionGetSwizzled(), StreamCollectionIsValid(), StreamCollectionOdbcToCollection(), StreamCollectionSet(), StreamCollectionSetObject(), StreamCollectionSetObjectId()


classmethod OnDeleteHandler(id) as %Status [ Language = objectscript ]
Deletes persisent mime attachemnts on object delete


trigger OnDeleteSQL (BEFORE event DELETE);

Inherited Members

Inherited Methods


Storage Model: Storage (HS.Message.XMLMessage)


Storage Model: Storage (HS.Message.XMLMessage)


Storage Model: Storage (HS.Message.XMLMessage)


Storage Model: Storage (HS.Message.XMLMessage)