This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %XML.Exchange.Metadata

%XML.Exchange.Metadata

class %XML.Exchange.Metadata extends %Library.RegisteredObject, %XML.Adaptor

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.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property ClassName as %String);
Property methods: ClassNameDisplayToLogical(), ClassNameGet(), ClassNameIsValid(), ClassNameLogicalToDisplay(), ClassNameLogicalToOdbc(), ClassNameNormalize(), ClassNameSet()
property Content as array of %String);
Property methods: ContentBuildValueArray(), ContentCollectionToDisplay(), ContentCollectionToOdbc(), ContentDisplayToCollection(), ContentDisplayToLogical(), ContentGet(), ContentGetObject(), ContentGetObjectId(), ContentGetSwizzled(), ContentIsValid(), ContentLogicalToDisplay(), ContentLogicalToOdbc(), ContentNormalize(), ContentOdbcToCollection(), ContentSet(), ContentSetObject(), ContentSetObjectId()
property Description as %String);
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property GUID as %CacheString (XMLPROJECTION = "ATTRIBUTE");
Property methods: GUIDGet(), GUIDIsValid(), GUIDSet()
property Id as %String);
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdLogicalToOdbc(), IdNormalize(), IdSet()

Methods (Including Private)

private method %OnNew(initvalue As %CacheString) as %Status
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

private method %OnValidateObject() as %Status
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.

method GetKey(SrcVer As %String)
Strip leading '$_Id:' and trailing '$' to avoid RCS keyword expansion when added to Perforce.
method InsertClass(ClassName As %String)
private method LoadContent(oref As %RegisteredObject) as %Status

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window