Skip to main content


abstract class EnsLib.RecordMap.Model.RecordProperty extends %Library.RegisteredObject, %XML.Adaptor

Abstract model superclass for Composite and Field objects. This class is needed to allow a collection of both object types to be created.

Property Inventory


parameter NAMESPACE =;
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 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 RecordType as EnsLib.RecordMap.Model.DataType.RecordType (XMLPROJECTION = "NONE");
A non-projected property to indicate what kind of RecordMap is being composed.
Property methods: RecordTypeDisplayToLogical(), RecordTypeGet(), RecordTypeIsValid(), RecordTypeLogicalToDisplay(), RecordTypeLogicalToOdbc(), RecordTypeNormalize(), RecordTypeSet()
property annotation as %String (MAXLEN = 1024);
Comments for the property.
Property methods: annotationDisplayToLogical(), annotationGet(), annotationIsValid(), annotationLogicalToDisplay(), annotationLogicalToOdbc(), annotationNormalize(), annotationSet()
property ignored as EnsLib.RecordMap.Model.DataType.Boolean (XMLPROJECTION = "ATTRIBUTE");
Field/Composite appears in the records, but should not be mapped to a property in the record object.
Property methods: ignoredDisplayToLogical(), ignoredGet(), ignoredIsValid(), ignoredLogicalToDisplay(), ignoredLogicalToXSD(), ignoredNormalize(), ignoredSet(), ignoredXSDToLogical()
property name as %String (XMLPROJECTION = "ATTRIBUTE") [ Required ];
The name of the Field or Composite.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property required as EnsLib.RecordMap.Model.DataType.Boolean (XMLPROJECTION = "ATTRIBUTE");
Indicate whether the property is required. In the case of Fields, this also indicates whether the property in InterSystems IRIS should be marked as required for successful validation.
Property methods: requiredDisplayToLogical(), requiredGet(), requiredIsValid(), requiredLogicalToDisplay(), requiredLogicalToXSD(), requiredNormalize(), requiredSet(), requiredXSDToLogical()

Inherited Members

Inherited Methods


FeedbackOpens in a new tab