This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


persistent class EnsLib.ITK.Framework.MessageDetails extends %Library.Persistent, %XML.Adaptor

SQL Table Name: EnsLib_ITK_Framework.MessageDetails

Copied, for code control purposes from: c:/temp/xsd/queuecollectionmessagetypes-2010-05.xsd MessagePayload becomes %GlobalCharacterStream

Property Inventory (Including Private)


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter NAMESPACE = urn:nhs-itk:ns:201005;
Inherited description: NAMESPACE specifies the XML namespace to be used when projecting the class to XML. if NAMESPACE - "", the default namespace is used for the XML schema is used as the namespace for his class.
parameter SrcVer = $Id$;
parameter XMLNAME = MessageDetails;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.


property MessageHandle as %String) [ Required ];
Property methods: MessageHandleDisplayToLogical(), MessageHandleGet(), MessageHandleGetStored(), MessageHandleIsValid(), MessageHandleLogicalToDisplay(), MessageHandleLogicalToOdbc(), MessageHandleNormalize(), MessageHandleSet()
property MessagePayload as %XML.GlobalCharacterStream (XMLNAME = "MessagePayload") [ Required ];
Property methods: MessagePayloadDelete(), MessagePayloadGet(), MessagePayloadGetObject(), MessagePayloadGetObjectId(), MessagePayloadGetStored(), MessagePayloadGetSwizzled(), MessagePayloadIsValid(), MessagePayloadNewObject(), MessagePayloadOid(), MessagePayloadOpen(), MessagePayloadSet(), MessagePayloadSetObject(), MessagePayloadSetObjectId(), MessagePayloadUnSwizzle()
property RelatesTo as %String);
Property methods: RelatesToDisplayToLogical(), RelatesToGet(), RelatesToGetStored(), RelatesToIsValid(), RelatesToLogicalToDisplay(), RelatesToLogicalToOdbc(), RelatesToNormalize(), RelatesToSet()
property ServiceMessageType as %String) [ Required ];
Property methods: ServiceMessageTypeDisplayToLogical(), ServiceMessageTypeGet(), ServiceMessageTypeGetStored(), ServiceMessageTypeIsValid(), ServiceMessageTypeLogicalToDisplay(), ServiceMessageTypeLogicalToOdbc(), ServiceMessageTypeNormalize(), ServiceMessageTypeSet()
property any as %XML.String (XMLNAME = "any", XMLPROJECTION = "ANY") [ SqlFieldName = _any ];
Property methods: anyDisplayToLogical(), anyGet(), anyGetStored(), anyIsValid(), anyLogicalToDisplay(), anyLogicalToOdbc(), anyNormalize(), anySet()


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

Inherited Members

Inherited Methods (Including Private)


Storage Model: CacheStorage (EnsLib.ITK.Framework.MessageDetails)