Skip to main content

%XML.Exchange.Metadata

Class %XML.Exchange.Metadata Extends (%RegisteredObject, %XML.Adaptor) [ System = 4 ]

Configuration Management Metadata Details pertaining to an individual Exchange Item.
This class is used to include this information in the XML export. Across different Exchange Item types the id, code and description may be kept in different tags. The metadata section provides these details in a consistent manner.

Properties

GUID

Property GUID As %RawString(XMLPROJECTION = "ATTRIBUTE");

Id

Property Id As %String(MAXLEN = "");

ClassName

Property ClassName As %String(MAXLEN = "");

Description

Property Description As %String(MAXLEN = "");

Content

Property Content As array Of %String(MAXLEN = "", XMLITEMNAME = "Class", XMLKEYNAME = "Version");

Methods

%OnNew

Method %OnNew(initvalue As %RawString) As %Status [ Private, ProcedureBlock = 1, ServerOnly = 1 ]

This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.

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

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status

LoadContent

Method LoadContent(oref As %RegisteredObject) As %Status [ Private ]

InsertClass

Method InsertClass(ClassName As %String)

GetKey

Method GetKey(SrcVer As %String) [ CodeMode = expression ]

Strip leading '$_Id:' and trailing '$' to avoid RCS keyword expansion when added to Perforce.

%OnValidateObject

Method %OnValidateObject() As %Status [ Private, ProcedureBlock = 1, ServerOnly = 1 ]

This callback method is invoked by the %ValidateObject method to provide notification that the current object is being validated.

If this method returns an error then %ValidateObject will fail.