%pkg.isc.changecontrol.xml.Adaptor
abstract class %pkg.isc.changecontrol.xml.Adaptor extends %XML.Adaptor, %pkg.isc.json.adaptor
XML AdaptorProperty Inventory
Method Inventory
Parameters
parameter FIELDOVERRIDES;
These properties are included for clients to customise the solution.
This parameter is used at installation to retain the property values.
Comma separated list of property names.
parameter SrcVer = $Id: //healthshare/appmodules/isc.changecontrol/1.2.1/cls/pkg/isc/changecontrol/xml/Adaptor.cls#1 $;
This Parameter should be updated when synced from Perforce
parameter XMLCONFIGITEM = 0;
Configuration Items are discrete elements whose development is to be controlled and tracked.
parameter XMLDEFAULTREFERENCE = GUID;
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.
parameter XMLVERSION = 0;
XML Compatibility Version
XML projections with a matching version are compatible. Projections using other versions may not import
depending on the extent of incompatible changes.
When the XML compatbile version is changed any existing XML projections using a previous compatability value may need to be re-exported.
Developers must increment this value in conjunction with any changes which are not backwards compatible.
Properties
property GUID as %RawString (%JSONINCLUDE = "NONE", XMLPROJECTION = "ATTRIBUTE") [ Transient ];
Property methods: GUIDIsValid()
Methods
method GUIDGet() as %RawString
method GUIDSet(Arg As %RawString) as %Status
method XMLClear(document As %XML.Document, node As %Integer, ByRef qstruct As %String)
Clear propety values in preparation for the values from XML import
Returns an value to identify the object.
This method may be overriden to return a code or description.
classmethod XMLGetElement(id As %String, Object As %RegisteredObject = $$$NULLOREF) as %String
Return the Oid of the configuration item that contains this object.
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()
classmethod XMLNew(document As %XML.Document, node As %Integer, containerOref As %RegisteredObject = "") as %RegisteredObject
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.
Arguments:
document is the document with %XML.Node or macros in %xmlDOM.inc.
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)
containerOref is the containing object instance when called from XMLImport and is "" when called from %XML.Reader for Correlated objects.
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.
Arguments:
document is the document with %XML.Node or macros in %xmlDOM.inc.
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)
containerOref is the containing object instance when called from XMLImport and is "" when called from %XML.Reader for Correlated objects.
Triggers
trigger ChangeControlAfterDelete (AFTER event DELETE);
trigger ChangeControlAfterInsert (AFTER event INSERT);
trigger ChangeControlAfterUpdate (AFTER event UPDATE);
trigger ChangeControlBeforeDelete (BEFORE event DELETE);
trigger ChangeControlBeforeInsert (BEFORE event INSERT);
trigger ChangeControlBeforeUpdate (BEFORE event UPDATE);