Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > EnsLib.RecordMap.Model.BatchElement
Private  Storage   

EnsLib.RecordMap.Model.BatchElement


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

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

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 6 2


Summary


Properties
annotation maxRepeats minRepeats name repeating
required

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject %XMLGenerate XMLAfterExport XMLBeforeExport
XMLDTD XMLExport XMLExportInternal XMLExportToStream
XMLExportToString XMLGetSchemaImports XMLImport XMLImportInternal
XMLIsObjectEmpty XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType isExplicitSpec

Subclasses
EnsLib.RecordMap.Model.RecordReference EnsLib.RecordMap.Model.RecordSequence

Parameters


• parameter NAMESPACE = "http://www.intersystems.com/Ensemble/RecordMap";
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;
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.

Properties


• property annotation as %String(MAXLEN=1024);
Comments for the element.
• property maxRepeats as %Integer(MINVAL=0,XMLPROJECTION="ATTRIBUTE");
If repeating is true, the maximum number of times that the element must appear.
• property minRepeats as %Integer(MINVAL=0,XMLPROJECTION="ATTRIBUTE");
If repeating is true, the minimum number of times that the element must appear.
• property name as %String(MAXLEN=128,XMLPROJECTION="ATTRIBUTE") [ Required ];
The name of the BatchElement.
• property repeating as EnsLib.RecordMap.Model.DataType.Boolean(XMLPROJECTION="ATTRIBUTE");
Indicate whether the element repeats.
• property required as EnsLib.RecordMap.Model.DataType.Boolean(XMLPROJECTION="ATTRIBUTE");
Indicate whether the element is required.

Methods


• private method %OnValidateObject() as %Status
Basic validation of the properties in the class.
• method isExplicitSpec() as %Boolean
Helper method to indicate whether the element will appear a known number of times. If the element is not required, or may appear a variable number of times, this method will return 0.