Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsLib] >  [RecordMap] >  [Operation] >  [ComplexBatchStandard]
Private  Storage   

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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 4 7


Summary

This is a Business Operation class.

RequestResponse
%Persistent %Persistent

Properties
%AlertStartTime %ConfigName %ConfigQueueName %LastActionTime
%LastHandledTime %LastReportedError %QuitTask %RequestHeader
%SessionId %SuperSession %WarnedLatest %isShadow
Adapter AlertGroups AlertOnError AlertRetryGracePeriod
ArchiveIO BusinessPartner ComplexMap DeferResponse
FailureTimeout IOLogEntry InactivityTimeout NoFailWhileDisconnected
OpenMode QueueCountAlert QueueWaitAlert ReplyCodeActions
Retry RetryCount RetryInterval SendSuperSession
SuspendMessage ThrottleDelay

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnClose %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %SuperSessionSet %ValidateObject AdapterName
AssignOneSetting CloseIOLogEntry DeferResponse EnumerateSettingsClose
EnumerateSettingsExecute EnumerateSettingsFetch GenerateSuperSession GetCharEncoding
GetDeferredResponseToken GetMessageList GetProductionSettingValue GetProductionSettings
GetPropertyConnections GetSettings GetShadowInstance GetTempStream
IncludeSuperSession NewIOLogEntry OnError OnFailureTimeout
OnGenerateSuperSession OnGetConnections OnGetReplyAction OnInit
OnKeepalive OnMessage OnMonitor OnProductionStart
OnProductionStop OnTearDown ProcessTempStream PutBatch
QueueName SaveIOLogEntry SendAlert SendDeferredResponse
SendRequestAsync SendRequestSync

Subclasses
EnsLib.RecordMap.Operation.ComplexBatchFileOperation

Parameters

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

Properties

• property ComplexMap as %String(MAXLEN=220) [ Required ];
Name of the Complex RecordMap which is to be written out.
• 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.

Methods

• method GetCharEncoding() as %String
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
Get a temporary file stream for output.
• method OnInit() as %Status
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
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
Subclass responsibility.
• method PutBatch(pBatch As EnsLib.RecordMap.ComplexBatch, pIOStream As %IO.DeviceStream) as %Status
Handle writing out a ComplexBatch to a supplied stream.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.