Skip to main content


persistent class HS.Reports.XMLMessageContainer extends %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_Reports.XMLMessageContainer

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 = 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 BinaryData as %GlobalBinaryStream;
Used to return PDF and other binary formats
Property methods: BinaryDataDelete(), BinaryDataGet(), BinaryDataGetObject(), BinaryDataGetObjectId(), BinaryDataGetStored(), BinaryDataGetSwizzled(), BinaryDataIsValid(), BinaryDataNewObject(), BinaryDataOid(), BinaryDataOpen(), BinaryDataSet(), BinaryDataSetObject(), BinaryDataSetObjectId(), BinaryDataUnSwizzle()
property HTMLData as %GlobalCharacterStream;
Used to Return HTML
Property methods: HTMLDataDelete(), HTMLDataGet(), HTMLDataGetObject(), HTMLDataGetObjectId(), HTMLDataGetStored(), HTMLDataGetSwizzled(), HTMLDataIsValid(), HTMLDataNewObject(), HTMLDataOid(), HTMLDataOpen(), HTMLDataSet(), HTMLDataSetObject(), HTMLDataSetObjectId(), HTMLDataUnSwizzle()
property Status as %Status;
Property methods: StatusGet(), StatusGetStored(), StatusIsValid(), StatusLogicalToOdbc(), StatusLogicalToXSD(), StatusSet(), StatusXSDToLogical()
property StringCollection as list of %String (MAXLEN = 32000);
to allow this to be used to pass arbitrary simple message lists
Property methods: StringCollectionBuildValueArray(), StringCollectionCollectionToDisplay(), StringCollectionCollectionToOdbc(), StringCollectionDisplayToCollection(), StringCollectionDisplayToLogical(), StringCollectionGet(), StringCollectionGetObject(), StringCollectionGetObjectId(), StringCollectionGetStored(), StringCollectionGetSwizzled(), StringCollectionIsValid(), StringCollectionLogicalToDisplay(), StringCollectionLogicalToOdbc(), StringCollectionNormalize(), StringCollectionOdbcToCollection(), StringCollectionSet(), StringCollectionSetObject(), StringCollectionSetObjectId()
property XMLData as %GlobalCharacterStream;
Used to Return various XML formats - SDA, CCD, CCR, etc.
Property methods: XMLDataDelete(), XMLDataGet(), XMLDataGetObject(), XMLDataGetObjectId(), XMLDataGetStored(), XMLDataGetSwizzled(), XMLDataIsValid(), XMLDataNewObject(), XMLDataOid(), XMLDataOpen(), XMLDataSet(), XMLDataSetObject(), XMLDataSetObjectId(), XMLDataUnSwizzle()


classmethod ReturnReportData(pReportRequest As HS.Message.ReportRequest) as HS.Reports.XMLMessageContainer


index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (HS.Reports.XMLMessageContainer)

FeedbackOpens in a new tab