Home > Class Reference > ENSLIB namespace > EnsLib.RecordMap.Service.Base

EnsLib.RecordMap.Service.Base

abstract class EnsLib.RecordMap.Service.Base extends Ens.BusinessService

Base class for Business Services which process streams containing data mapped to RecordMaps and/or batches of RecordMaps.

Parameters

parameter SETTINGS = RecordMap:Basic:selector?context={Ens.ContextSearch/RecordMaps},TargetConfigNames:Basic:selector?multiSelect=1&context={Ens.ContextSearch/ProductionItems?targets=1&productionName=@productionId},SynchronousSend;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

property RecordMap as %String (MAXLEN = 220) [ Required ];
Name of the RecordMap to use for processing the incoming data.
Property methods: RecordMapDisplayToLogical(), RecordMapGet(), RecordMapIsValid(), RecordMapLogicalToDisplay(), RecordMapLogicalToOdbc(), RecordMapNormalize(), RecordMapSet()
property SynchronousSend as %Boolean [ InitialExpression = 0 ];
Control whether requests should be sent synchronously or asynchronously to the items listed in TargetConfigNames. The default is false.
Property methods: SynchronousSendDisplayToLogical(), SynchronousSendGet(), SynchronousSendIsValid(), SynchronousSendLogicalToDisplay(), SynchronousSendNormalize(), SynchronousSendSet()
property TargetConfigNames as %String);
A comma-separated list of Configuration Items which should receive the parsed objects.
Property methods: TargetConfigNamesDisplayToLogical(), TargetConfigNamesGet(), TargetConfigNamesIsValid(), TargetConfigNamesLogicalToDisplay(), TargetConfigNamesLogicalToOdbc(), TargetConfigNamesNormalize(), TargetConfigNamesSet()

Methods

method GetObject(pStream As %IO.DeviceStream, Output pObject As EnsLib.RecordMap.Base, pTimeout As %Numeric = -1, ByRef pLookAhead As %String = "", pLabelFound As %Boolean = 0) as %Status [ Language = objectscript ]
Wrap the GetObject() method in the RecordMap class.
classmethod OnGetConnections(Output pArray As %String, pItem As Ens.Config.Item) [ Language = objectscript ]
Add connections from TargetConfigNames
method OnInit() as %Status [ Language = objectscript ]
Ensure that the RecordMap and the target class exist and are based on the RecordMap framework.
method SendRequest(pRequest As %Persistent, pAsync As %Boolean = 1, Output pResponses As %ListOfObjects) as %Status [ Language = objectscript ]
Send the generated object to the requested targets.

Inherited Methods

%AddToSaveSet() %OnNew() GetPropertyConnections()
%ClassIsLatestVersion() %OriginalNamespace() GetSettings()
%ClassName() %PackageName() GetShadowInstance()
%ConstructClone() %RemoveFromSaveSet() NewIOLogEntry()
%DispatchClassMethod() %SerializeObject() OnError()
%DispatchGetModified() %SetModified() OnGenerateSuperSession()
%DispatchGetProperty() %SuperSessionSet() OnKeepalive()
%DispatchMethod() %ValidateObject() OnMonitor()
%DispatchSetModified() AdapterName() OnProcessInput()
%DispatchSetMultidimProperty() AssignOneSetting() OnProductionStart()
%DispatchSetProperty() CloseIOLogEntry() OnProductionStop()
%Extends() EnumerateSettingsClose() OnTearDown()
%GetParameter() EnumerateSettingsExecute() PopulateSuperSession()
%IsA() EnumerateSettingsFetch() QueueName()
%IsModified() ForceSessionId() SaveIOLogEntry()
%New() GenerateSuperSession() SendAlert()
%NormalizeObject() GetDeferredResponseToken() SendDeferredResponse()
%ObjectModified() GetProductionSettingValue() SendRequestAsync()
%OnClose() GetProductionSettings() SendRequestSync()

Subclasses

EnsLib.RecordMap.Service.BatchStandard EnsLib.RecordMap.Service.Standard