Inheritance diagram for Adaptor:

Collaboration diagram for Adaptor:

Public Member Functions
_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...

	XMLClear ()
	Clear propety values in preparation for the values from XML import.

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Static Public Member Functions
_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.String	XMLExchangeName (_.Library.String id)
	Returns an value to identify the object. More...

_.Library.String	XMLExchangePath (_.Library.String id)
	For very large tables it is necessary to break the records down into. More...

_.Library.String	XMLGetElement (_.Library.String id, _.Library.RegisteredObject Object)
	Return the Oid of the Exchange Item that contains this object.

_.Library.RegisteredObject	XMLLoadGUID (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Returns a matching object based on unique indices.

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Public Attributes
	GUID
	More...

Static Public Attributes
	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...

	XMLDEFAULTREFERENCE = None
	Default value of XMLREFERENCE that specifies how to project references to XML. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

XML Exchange Adaptor.

Sub-classes of XML.Exchange.Adaptor are included in Configuration Management. Configuration Mangement is used to export and import Exchange Items. The items are written in XML such that the data is readable and different revisions of the item may be compared to identify changes.

Member Function Documentation

◆ OnAfterDelete()

_.Library.Status OnAfterDelete ( _.Library.ObjectIdentity oid )

static

This callback method is invoked by the <METHOD>Delete</METHOD> method to.

provide notification that the object specified by oid has been deleted. The callback occurs immediately after DeleteData has been called. If DeleteData returns an error then OnAfterDelete is not called.

If OnAfterDelete returns an error (Status) then the transaction is rolled back.

◆ OnAfterSave()

_.Library.Status OnAfterSave ( _.Library.Boolean insert )

This callback method is invoked by the <METHOD>Save</METHOD> method to.

provide notification that the object is being saved. It is called after the object's data has been successfully written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to <METHOD>Save</METHOD> will fail.

◆ OnBeforeSave()

_.Library.Status OnBeforeSave ( _.Library.Boolean insert )

This callback method is invoked by the <METHOD>Save</METHOD> method to.

provide notification that the object is being saved. It is called before any data is written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to <METHOD>Save</METHOD> will fail.

◆ OnDelete()

_.Library.Status OnDelete ( _.Library.ObjectIdentity oid )

static

This callback method is invoked by the <METHOD>Delete</METHOD> 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.

◆ OnOpen()

_.Library.Status OnOpen ( )

This callback method is invoked by the <METHOD>Open</METHOD> method to.

provide notification that the object specified by oid is being opened.

If this method returns an error then the object will not be opened.

◆ XMLExchangeName()

_.Library.String XMLExchangeName ( _.Library.String id )

static

Returns an value to identify the object.

This method may be overriden to return a code or description.

◆ XMLExchangePath()

_.Library.String XMLExchangePath ( _.Library.String id )

static

For very large tables it is necessary to break the records down into.

sub-directories. This method returns the sub-directory name to be used for the given id.

The sub-directory returned is then appended to the path using ##class(File).SubDirectoryName()

◆ XMLNew()

_.Library.RegisteredObject XMLNew	(	_.XML.Document	document,
		_.Library.Integer	node,
		_.Library.RegisteredObject	containerOref
	)

static

Get an instance of an XML enabled class.

You may override this method to do custom processing (such as initializing
the object instance) before returning an instance of this class.
However, this method should not be called directly from user code.<br>
Arguments:<br>
    document is the document with %XML.Node or macros in %xmlDOM.inc.<br>
    nodeId is a node id of the node which defines this object.
        An %XML.Node object may be obtained for this node using document.GetNode(nodeId)<br>
    containerOref is the containing object instance when called from XMLImport and
        is "" when called from %XML.Reader for Correlate'd objects.<br>

Reimplemented from Adaptor.

Member Data Documentation

◆ GUIDENABLED

GUIDENABLED = None

static

If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object.

When the object is saved for the first time this GUID value will be recorded in a namespace index which will allow GUID to be resolved to OIDs.

◆ XMLDEFAULTREFERENCE

XMLDEFAULTREFERENCE = None

static

Default value of XMLREFERENCE that specifies how to project references to XML.

XMLREFERENCE may be overridden for each property. SUMMARY indicates that only the summary properies of the referenced class are used to represent the reference. SUMMARY is the default. Note that by default all properties are of the referenced class are in the summary. COMPLETE indicates that all properties of the referenced class are used to represent the reference. ID indicates that the id of a persistent or serial class is used to represent the reference. OID indicates that the oid of a persistent or serial class is used to represent the reference. The form of the oid will be classname,id. GUID indicates the the GUID of a persistent class is used to represent the reference.

◆ GUID

GUID

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ OnAfterDelete()

◆ OnAfterSave()

◆ OnBeforeSave()

◆ OnDelete()

◆ OnOpen()

◆ XMLExchangeName()

◆ XMLExchangePath()

◆ XMLNew()

Member Data Documentation

◆ GUIDENABLED

◆ XMLDEFAULTREFERENCE

◆ GUID