BaseDataAdapter Class

This is a Library topic for Data Abstract for .NET
This page is generated from external data, please do not update

Namespaces — Interfaces — Classes — Enums — Implements

Overview

The BaseDataAdapter is a base class for all data adapters (both Local Data Adapters and Remote Data Adapters) available in the Data Abstract for .NET. This class doesn't provide any real data access functionality. Instead it provides several utility methods and common infrastructure used by all data adapters.

This class cannot be instantiated directly.

Location

• Assembly: RemObjects.DataAbstract.dll
• Namespace: RemObjects.DataAbstract
• Ancestry: BaseComponent | BaseDataAdapter | Descendants

Implemented interfaces

• IScriptContext

Properties

AcceptChangesDuringFill
Gets or sets a flag indicating whether all target DataTable changes made during data retrieval from the Data Abstract server should be commited. If this property is set to false then some or all data rows in the target DataTable will be marked as updated or inserted after the Fill operation is completed. The default value is true. Prism:   property AcceptChangesDuringFill: Boolean read write C#:   Boolean AcceptChangesDuringFill { get; set; } VB:   Property AcceptChangesDuringFill As Boolean
AcceptChangesDuringUpdate
Gets or sets a flag indicating whether all DataTable changes should be automatically commited after the update data is sent to the Data Abstract server should be commited. If this property is set to false then data rows in the target DataTable will remain to be marked as updated or inserted after the Update operation is completed. The default value is true. Prism:   property AcceptChangesDuringUpdate: Boolean read write C#:   Boolean AcceptChangesDuringUpdate { get; set; } VB:   Property AcceptChangesDuringUpdate As Boolean
AutoLoadScripts
Gets or sets flag indicating whether Business Rules Scripting API scripts should be automaically downloaded from the Data Abstract server when the data is retreved from the server. Prism:   property AutoLoadScripts: Boolean read write C#:   Boolean AutoLoadScripts { get; set; } VB:   Property AutoLoadScripts As Boolean
CacheSchema
Gets or sets flag indicating whether Schema retrieved from the server via the ReadSchema method call should be chached in the Schema property. Setting this property to false can significantly decrease performance. The default value is true. Prism:   property CacheSchema: Boolean read write C#:   Boolean CacheSchema { get; set; } VB:   Property CacheSchema As Boolean
DynamicSelect
Gets or sets a flag indicating whether Data Adapter should perform queries using the Dynamic Select feature Prism:   property DynamicSelect: Boolean read write C#:   Boolean DynamicSelect { get; set; } VB:   Property DynamicSelect As Boolean
FailureBehavior
Gets or sets intended Data Adapter behavior on data update errors. Prism:   property FailureBehavior: FailureBehavior read write C#:   FailureBehavior FailureBehavior { get; set; } VB:   Property FailureBehavior As FailureBehavior
GetSchemaOnFirstFill
Gets or sets a flag indicating whether Schema should be downloaded from the remote Data Abstract server right before the first data request. The default value is true. Prism:   property GetSchemaOnFirstFill: Boolean read write C#:   Boolean GetSchemaOnFirstFill { get; set; } VB:   Property GetSchemaOnFirstFill As Boolean
Schema
Gets the Schema currently cached by the Data Adapter instance Prism:   property Schema: Schema read C#:   Schema Schema { get; } VB:   Property ReadOnly Schema As Schema
ScriptProvider
Gets or sets Business Rules Scripting API provided that will be used to execute client-side scripts. Prism:   property ScriptProvider: IScriptProvider read write C#:   IScriptProvider ScriptProvider { get; set; } VB:   Property ScriptProvider As IScriptProvider
Status
Gets current status of the Data Adapter Prism:   property Status: RemoteAdapterStatus read C#:   RemoteAdapterStatus Status { get; } VB:   Property ReadOnly Status As RemoteAdapterStatus

Instance Methods

constructor ()   protected
Creates a new instance of the BaseDataAdapter class and performs the license check. Oxygene:   constructor C#:   constructor() VB:   Sub New
constructor (Boolean)   protected
Creates a new instance of the BaseDataAdapter class and performs the license check unless the avoidLicenseCheck argument is set to true. Oxygene:   constructor(avoidLicenseCheck: Boolean) C#:   constructor(Boolean avoidLicenseCheck) VB:   Sub New (avoidLicenseCheck As Boolean) Parameters: avoidLicenseCheck: Flag indicating whether license chec can be skipped
constructor (IContainer)   protected
Creates a new instance of the BaseDataAdapter class, performs the license check and then adds the newly created instance to the provided component container. Oxygene:   constructor(container: IContainer) C#:   constructor(IContainer container) VB:   Sub New (container As IContainer) Parameters: container: Components container that will contain the instance being created
BeginInternalUpdate   protected
Starts asynchronous data update operation. Oxygene:   method BeginInternalUpdate(cb: AsyncCallback; state: Object; deltas: array of Delta): IAsyncResult C#:   IAsyncResult BeginInternalUpdate(AsyncCallback cb, Object state, array of Delta deltas) VB:   Function BeginInternalUpdate(cb As AsyncCallback, state As Object, deltas As array of Delta) As IAsyncResult Parameters: cb: Callback method that will be called once the asynchronous data update call is completed state: Asynchronous operation state object deltas: Collection of Delta instances that will be send to the Data Abstract server
CheckFailures   protected
Composes the data update failure message based on the Delta information returned from the server after the Udate call. Oxygene:   method CheckFailures(delta: Delta; changes: List<DeltaChange>; failureMessage: StringBuilder) C#:   void CheckFailures(Delta delta, List<DeltaChange> changes, StringBuilder failureMessage) VB:   Sub CheckFailures(delta As Delta, changes As List<DeltaChange>, failureMessage As StringBuilder) Parameters: delta: Delta instance returned from the Data Abstract server changes: Collection that will contain a list of the DeltaChange instances that server marked as ChangeStatus.Failed failureMessage: String builder instace that will contain composed data update failure message
EndInternalUpdate   protected
Finishes the asynchronous data update operation and performs needed cleanup actions, f.e. merges back updated AutoInc values retrieved from the server. Oxygene:   method EndInternalUpdate(ar: IAsyncResult) C#:   void EndInternalUpdate(IAsyncResult ar) VB:   Sub EndInternalUpdate(ar As IAsyncResult) Parameters: ar: Object representing the status of an asynchronous operation
EnterCriticalSection   protected
This method is called on entering a method or code region that should be accessed by a single thread only at any given moment of time. If a thread calls this method while such method is being executed then the calling thread will be paused until the critical code section is released by the blocking thread. Oxygene:   method EnterCriticalSection(status: RemoteAdapterStatus) C#:   void EnterCriticalSection(RemoteAdapterStatus status) VB:   Sub EnterCriticalSection(status As RemoteAdapterStatus) Parameters: status: Value that should be assigned to the Status property until the critical code section is exited
ExitCriticalSection   protected
This method is called on exiting a method or code region that should be accessed by a single thread only at any given moment of time. This method sets the Status property to RemoteAdapterStatus.Idle and then releases the critical code section lock. Oxygene:   method ExitCriticalSection C#:   void ExitCriticalSection() VB:   Sub ExitCriticalSection
FlushSchema
Cleans up the Schema cache and sets the Schema to null. Oxygene:   method FlushSchema C#:   void FlushSchema() VB:   Sub FlushSchema
LoadScripts
Downloads Business Rules Scripting API scripts from the server. In its current implementation this method downloads entire Schema from the Data Abstract server. Oxygene:   method LoadScripts C#:   void LoadScripts() VB:   Sub LoadScripts
ReadSchema
Downloads the Schema from the Data Abstract server . Oxygene:   method ReadSchema(forceReRead: Boolean): Schema C#:   Schema ReadSchema(Boolean forceReRead) VB:   Function ReadSchema(forceReRead As Boolean) As Schema Parameters: forceReRead: Flag indicating whether Schema should be downloaded even if the Schema is already cached in the %%BaseDataAdapter%Schema%% property
ReadStreamerSchema   protected
Downloads the Schema from the Data Abstract server. This method is used when the server exposes the Schema using method that sends it using highly-optimized binary stream (opposing to the ReadSchema method that is called when the server exposes its Schema as Xml). Oxygene:   method ReadStreamerSchema: Binary C#:   Binary ReadStreamerSchema() VB:   Function ReadStreamerSchema As Binary

Descendants

• DataAdapter
  • LocalDataAdapter
  • RemoteDataAdapter
• LinqDataAdapter
  • LinqLocalDataAdapter
  • LinqRemoteDataAdapter

See Also

• Local Data Adapters
• Remote Data Adapters
• Lists
  • Data Abstract for .NET:   Namespaces — Interfaces — Classes — Enums — Implements
    • RemObjects SDK for .NET:   Namespaces — Interfaces — Classes — Enums — Implements
    • RemObjects Script for .NET:   Namespaces — Classes
  • Data Abstract shared:   Data Types – File Types
  • other editions:
    • Data Abstract for Xcode:   Protocols — Classes — Enums — Implements
    • Data Abstract for Delphi:   Interfaces — Classes — Enums — Aliases — Implements
    • Data Abstract for Java:   Namespaces — Interfaces — Classes — Enums — Implements
    • Data Abstract for JavaScript:   Objects

Product: RemObjects Data Abstract
Available Editions: Data Abstract for .NET, Delphi and Xcode

Glossary — Articles — Features — Library — Samples