This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


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

Base class to model the elements used in EnsLib.RecordMap.Model.ComplexBatch.

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 annotation as %String (MAXLEN = 1024);
Comments for the element.
Property methods: annotationDisplayToLogical(), annotationGet(), annotationIsValid(), annotationLogicalToDisplay(), annotationLogicalToOdbc(), annotationNormalize(), annotationSet()
property maxRepeats as %Integer (MINVAL = 0, XMLPROJECTION = "ATTRIBUTE");
If repeating is true, the maximum number of times that the element must appear.
Property methods: maxRepeatsDisplayToLogical(), maxRepeatsGet(), maxRepeatsIsValid(), maxRepeatsLogicalToDisplay(), maxRepeatsNormalize(), maxRepeatsSet(), maxRepeatsXSDToLogical()
property minRepeats as %Integer (MINVAL = 0, XMLPROJECTION = "ATTRIBUTE");
If repeating is true, the minimum number of times that the element must appear.
Property methods: minRepeatsDisplayToLogical(), minRepeatsGet(), minRepeatsIsValid(), minRepeatsLogicalToDisplay(), minRepeatsNormalize(), minRepeatsSet(), minRepeatsXSDToLogical()
property name as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE") [ Required ];
The name of the BatchElement.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property repeating as EnsLib.RecordMap.Model.DataType.Boolean (XMLPROJECTION = "ATTRIBUTE");
Indicate whether the element repeats.
Property methods: repeatingDisplayToLogical(), repeatingGet(), repeatingIsValid(), repeatingLogicalToDisplay(), repeatingLogicalToXSD(), repeatingNormalize(), repeatingSet(), repeatingXSDToLogical()
property required as EnsLib.RecordMap.Model.DataType.Boolean (XMLPROJECTION = "ATTRIBUTE");
Indicate whether the element is required.
Property methods: requiredDisplayToLogical(), requiredGet(), requiredIsValid(), requiredLogicalToDisplay(), requiredLogicalToXSD(), requiredNormalize(), requiredSet(), requiredXSDToLogical()

Inherited Members

Inherited Methods