InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > EnsLib.RecordMap.Operation.ComplexBatchStandard


abstract class EnsLib.RecordMap.Operation.ComplexBatchStandard extends Ens.BusinessOperation

Base class for writing out RecordMap ComplexBatch objects. The batch will be written to a temporary file, and the ProcessTempFile()() callback will be invoked when complete to allow subclasses to transmit the batch to its destination.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter SETTINGS = ComplexMap:Basic:selector?context={/Classes?super=EnsLib.RecordMap.ComplexMap&hideAbstract=1},OpenMode;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties (Including Private)

property ComplexMap as %String (MAXLEN = 220) [ Required ];
Name of the Complex RecordMap which is to be written out.
Property methods: ComplexMapDisplayToLogical(), ComplexMapGet(), ComplexMapIsValid(), ComplexMapLogicalToDisplay(), ComplexMapLogicalToOdbc(), ComplexMapNormalize(), ComplexMapSet()
property OpenMode as %String [ InitialExpression = "RWN" ];
Mode to open the temporary file with when creating a new file for a batch. See the documentation for %IO.FileStream and file devices for more information on the available options.
Property methods: OpenModeDisplayToLogical(), OpenModeGet(), OpenModeIsValid(), OpenModeLogicalToDisplay(), OpenModeLogicalToOdbc(), OpenModeNormalize(), OpenModeSet()
property batchClass as %String (MAXLEN = 220) [ Private , Transient ];
Classname of the expected ComplexBatch objects.
Property methods: batchClassDisplayToLogical(), batchClassGet(), batchClassIsValid(), batchClassLogicalToDisplay(), batchClassLogicalToOdbc(), batchClassNormalize(), batchClassSet()
property complexMapFull as %String (MAXLEN = 220) [ Private , Transient ];
Full classname of the Complex RecordMap.
Property methods: complexMapFullDisplayToLogical(), complexMapFullGet(), complexMapFullIsValid(), complexMapFullLogicalToDisplay(), complexMapFullLogicalToOdbc(), complexMapFullNormalize(), complexMapFullSet()

Methods (Including Private)

method GetCharEncoding() as %String [ Language = objectscript ]
Return the expected character encoding to use for the output. The Batch operation uses a temp file to store data prior to writing out the end of the batch, and we need to know what encoding we should use to match the final output encoding. Subclasses that specify alternate character encodings should override this method.
method GetTempStream(Output pIOStream As %IO.DeviceStream) as %Status [ Language = objectscript ]
Get a temporary file stream for output.
method OnInit() as %Status [ Language = objectscript ]
Confirm that the Complex RecordMap exists and confirm that the ComplexBatch class has been generated.
method OnMessage(pRequest As %Persistent, Output pResponse As %Persistent) as %Status [ Language = objectscript ]
Handle incoming ComplexBatch objects. The entire ComplexBatch will be written out at that point in time.
method ProcessTempStream(pTempStream As %IO.DeviceStream, pBatch As EnsLib.RecordMap.ComplexBatch) as %Status [ Language = objectscript ]
Subclass responsibility.
method PutBatch(pBatch As EnsLib.RecordMap.ComplexBatch, pIOStream As %IO.DeviceStream) as %Status [ Language = objectscript ]
Handle writing out a ComplexBatch to a supplied stream.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)