DataAdapter

Overview

The DataAdapter abstract vase class is one of the core classes in the DataAbstract for .NET infrastructure. This class provides client-side access to a set of data tables published on the server.

This is a base class for data-table based Data Adapters.

Location


 

constructor  protected

Creates a new instance of the DataAdapter class.

Cannot be called directly.

 

constructor

 

DataAdapter()

 

Sub New()

constructor (Boolean)  protected

 

constructor(avoidLicenseCheck: Boolean)

 

DataAdapter(Boolean avoidLicenseCheck)

 

Sub New(avoidLicenseCheck As Boolean)

Parameters:

  • avoidLicenseCheck:

constructor (IContainer)  protected

Creates a new instance of the DataAdapter class and adds it to the provided components container.

Cannot be called directly.

 

constructor(container: IContainer)

 

DataAdapter(IContainer container)

 

Sub New(container As IContainer)

Parameters:

  • container: Components container

AcceptChangesDuringFill    (declared in BaseDataAdapter)

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.

 

property AcceptChangesDuringFill: Boolean read write;

 

Boolean AcceptChangesDuringFill { get; set; }

 

Property AcceptChangesDuringFill() As Boolean

AcceptChangesDuringUpdate    (declared in BaseDataAdapter)

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.

 

property AcceptChangesDuringUpdate: Boolean read write;

 

Boolean AcceptChangesDuringUpdate { get; set; }

 

Property AcceptChangesDuringUpdate() As Boolean

AfterFillDataSet

 

event AfterFillDataSet: RemoteDataAdapterFillDataSetEventHandler;
delegate: method AfterFillDataSet(sender: Object; e: RemoteDataAdapterFillDataSetEventArgs)

 

delegate RemoteDataAdapterFillDataSetEventHandler AfterFillDataSet()
delegate: void AfterFillDataSet(Object sender, RemoteDataAdapterFillDataSetEventArgs e)

 

Event AfterFillDataSet As RemoteDataAdapterFillDataSetEventHandler
delegate: Sub AfterFillDataSet(sender As Object, e As RemoteDataAdapterFillDataSetEventArgs)

AfterFillDataTable

 

event AfterFillDataTable: RemoteDataAdapterDataTableEventHandler;
delegate: method AfterFillDataTable(sender: Object; e: RemoteDataAdapterDataTableEventArgs)

 

delegate RemoteDataAdapterDataTableEventHandler AfterFillDataTable()
delegate: void AfterFillDataTable(Object sender, RemoteDataAdapterDataTableEventArgs e)

 

Event AfterFillDataTable As RemoteDataAdapterDataTableEventHandler
delegate: Sub AfterFillDataTable(sender As Object, e As RemoteDataAdapterDataTableEventArgs)

AfterFillDataTableSchema

This event is raised once a DataTable defined in the Schema has been added to the target DataSet.

This event can be used to fine-tune the added DataTable.

 

event AfterFillDataTableSchema: RemoteDataAdapterDataTableEventHandler;
delegate: method AfterFillDataTableSchema(sender: Object; e: RemoteDataAdapterDataTableEventArgs)

 

delegate RemoteDataAdapterDataTableEventHandler AfterFillDataTableSchema()
delegate: void AfterFillDataTableSchema(Object sender, RemoteDataAdapterDataTableEventArgs e)

 

Event AfterFillDataTableSchema As RemoteDataAdapterDataTableEventHandler
delegate: Sub AfterFillDataTableSchema(sender As Object, e As RemoteDataAdapterDataTableEventArgs)

AfterMergeDelta

This event is raised when changes contained in a Delta have been merged back into the DataSet.

 

event AfterMergeDelta: RemoteDataAdapterDataTableDeltaEventHandler;
delegate: method AfterMergeDelta(sender: Object; e: RemoteDataAdapterDataTableDeltaEventArgs)

 

delegate RemoteDataAdapterDataTableDeltaEventHandler AfterMergeDelta()
delegate: void AfterMergeDelta(Object sender, RemoteDataAdapterDataTableDeltaEventArgs e)

 

Event AfterMergeDelta As RemoteDataAdapterDataTableDeltaEventHandler
delegate: Sub AfterMergeDelta(sender As Object, e As RemoteDataAdapterDataTableDeltaEventArgs)

AfterUpdateDataSet

This event is raised once the process of applying changes to the server has been successfully completed.

 

event AfterUpdateDataSet: RemoteDataAdapterDataSetEventHandler;
delegate: method AfterUpdateDataSet(sender: Object; e: RemoteDataAdapterDataSetEventArgs)

 

delegate RemoteDataAdapterDataSetEventHandler AfterUpdateDataSet()
delegate: void AfterUpdateDataSet(Object sender, RemoteDataAdapterDataSetEventArgs e)

 

Event AfterUpdateDataSet As RemoteDataAdapterDataSetEventHandler
delegate: Sub AfterUpdateDataSet(sender As Object, e As RemoteDataAdapterDataSetEventArgs)

AutoLoadScripts    (declared in BaseDataAdapter)

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.

 

property AutoLoadScripts: Boolean read write;

 

Boolean AutoLoadScripts { get; set; }

 

Property AutoLoadScripts() As Boolean

BeforeFillDataSet

 

event BeforeFillDataSet: RemoteDataAdapterFillDataSetEventHandler;
delegate: method BeforeFillDataSet(sender: Object; e: RemoteDataAdapterFillDataSetEventArgs)

 

delegate RemoteDataAdapterFillDataSetEventHandler BeforeFillDataSet()
delegate: void BeforeFillDataSet(Object sender, RemoteDataAdapterFillDataSetEventArgs e)

 

Event BeforeFillDataSet As RemoteDataAdapterFillDataSetEventHandler
delegate: Sub BeforeFillDataSet(sender As Object, e As RemoteDataAdapterFillDataSetEventArgs)

BeforeFillDataTable

 

event BeforeFillDataTable: RemoteDataAdapterDataTableEventHandler;
delegate: method BeforeFillDataTable(sender: Object; e: RemoteDataAdapterDataTableEventArgs)

 

delegate RemoteDataAdapterDataTableEventHandler BeforeFillDataTable()
delegate: void BeforeFillDataTable(Object sender, RemoteDataAdapterDataTableEventArgs e)

 

Event BeforeFillDataTable As RemoteDataAdapterDataTableEventHandler
delegate: Sub BeforeFillDataTable(sender As Object, e As RemoteDataAdapterDataTableEventArgs)

BeforeMergeDelta

This event is raised when changes contained in a Delta have been received from the server and are ready to be merged back into the DataSet.

 

event BeforeMergeDelta: RemoteDataAdapterDataTableDeltaEventHandler;
delegate: method BeforeMergeDelta(sender: Object; e: RemoteDataAdapterDataTableDeltaEventArgs)

 

delegate RemoteDataAdapterDataTableDeltaEventHandler BeforeMergeDelta()
delegate: void BeforeMergeDelta(Object sender, RemoteDataAdapterDataTableDeltaEventArgs e)

 

Event BeforeMergeDelta As RemoteDataAdapterDataTableDeltaEventHandler
delegate: Sub BeforeMergeDelta(sender As Object, e As RemoteDataAdapterDataTableDeltaEventArgs)

BeforeUpdateDataSet

This event is raised before data changes are applied to the server.

This event can be used to fine-tune the added data.

 

event BeforeUpdateDataSet: RemoteDataAdapterDataSetEventHandler;
delegate: method BeforeUpdateDataSet(sender: Object; e: RemoteDataAdapterDataSetEventArgs)

 

delegate RemoteDataAdapterDataSetEventHandler BeforeUpdateDataSet()
delegate: void BeforeUpdateDataSet(Object sender, RemoteDataAdapterDataSetEventArgs e)

 

Event BeforeUpdateDataSet As RemoteDataAdapterDataSetEventHandler
delegate: Sub BeforeUpdateDataSet(sender As Object, e As RemoteDataAdapterDataSetEventArgs)

BeginInit    (declared in BaseDataAdapter)

 

method BeginInit

 

void BeginInit()

 

Sub BeginInit()

BeginInternalUpdate  protected    (declared in BaseDataAdapter)

Starts asynchronous data update operation.

 

method BeginInternalUpdate(deltas: array of Delta; cb: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginInternalUpdate(Delta[] deltas, AsyncCallback cb, Object state)

 

Function BeginInternalUpdate(deltas As Delta(), cb As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • deltas: Collection of Delta instances that will be send to the Data Abstract server
  • cb: Callback method that will be called once the asynchronous data update call is completed
  • state: Asynchronous operation state object

CacheSchema    (declared in BaseDataAdapter)

Gets or sets flag indicating whether Schema retrieved from the server via the BaseDataAdapter method call should be chached in the BaseDataAdapter property. Setting this property to false can significantly decrease performance.

The default value is true.

 

property CacheSchema: Boolean read write;

 

Boolean CacheSchema { get; set; }

 

Property CacheSchema() As Boolean

CheckAdapterSettings  protected    (declared in BaseDataAdapter)

Performs required internal data adapter initialization before issuing a data read or update request.

 

method CheckAdapterSettings

 

void CheckAdapterSettings()

 

Sub CheckAdapterSettings()

CheckFailures  protected    (declared in BaseDataAdapter)

Composes the data update failure message based on the Delta information returned from the server after the Udate call.

 

method CheckFailures(delta: Delta; changes: List<DeltaChange>; failureMessage: StringBuilder)

 

void CheckFailures(Delta delta, List<DeltaChange> changes, StringBuilder failureMessage)

 

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
  • failureMessage: String builder instace that will contain composed data update failure message

DynamicSelect    (declared in BaseDataAdapter)

Gets or sets a flag indicating whether Data Adapter should perform queries using the Dynamic Select feature

 

property DynamicSelect: Boolean read write;

 

Boolean DynamicSelect { get; set; }

 

Property DynamicSelect() As Boolean

EndInit    (declared in BaseDataAdapter)

 

method EndInit

 

void EndInit()

 

Sub EndInit()

EndInternalUpdate  protected    (declared in BaseDataAdapter)

Finishes the asynchronous data update operation and performs needed cleanup actions, f.e. merges back updated AutoInc values retrieved from the server.

 

method EndInternalUpdate(ar: IAsyncResult)

 

void EndInternalUpdate(IAsyncResult ar)

 

Sub EndInternalUpdate(ar As IAsyncResult)

Parameters:

  • ar: Object representing the status of an asynchronous operation

EnterCriticalSection  protected    (declared in BaseDataAdapter)

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.

 

method EnterCriticalSection(status: DataAdapterStatus)

 

void EnterCriticalSection(DataAdapterStatus status)

 

Sub EnterCriticalSection(status As DataAdapterStatus)

Parameters:

  • status: Value that should be assigned to the BaseDataAdapter property until the critical code section is exited

Execute (String): Int32    (declared in BaseDataAdapter)

 

method Execute(commandName: String): Int32

 

Int32 Execute(String commandName)

 

Function Execute(commandName As String) As Int32

Parameters:

  • commandName:

Execute (String, array of Object, DataParameter): Int32    (declared in BaseDataAdapter)

 

method Execute(commandName: String; inputParameters: array of Object; out outputParameterts: DataParameter): Int32

 

Int32 Execute(String commandName, Object[] inputParameters, out DataParameter outputParameterts)

 

Function Execute(commandName As String, inputParameters As Object(), <OutAttribute> ByRef outputParameterts As DataParameter) As Int32

Parameters:

  • commandName:
  • inputParameters:
  • outputParameterts:

Execute (String, array of DataParameter, DataParameter): Int32    (declared in BaseDataAdapter)

 

method Execute(commandName: String; inputParameters: array of DataParameter; out outputParameterts: DataParameter): Int32

 

Int32 Execute(String commandName, DataParameter[] inputParameters, out DataParameter outputParameterts)

 

Function Execute(commandName As String, inputParameters As DataParameter(), <OutAttribute> ByRef outputParameterts As DataParameter) As Int32

Parameters:

  • commandName:
  • inputParameters:
  • outputParameterts:

Execute (String, array of Object): Int32    (declared in BaseDataAdapter)

 

method Execute(commandName: String; params inputParameters: array of Object): Int32

 

Int32 Execute(String commandName, params Object[] inputParameters)

 

Function Execute(commandName As String, ParamArray inputParameters As Object()) As Int32

Parameters:

  • commandName:
  • inputParameters:

Execute (String, array of DataParameter): Int32    (declared in BaseDataAdapter)

 

method Execute(commandName: String; params inputParameters: array of DataParameter): Int32

 

Int32 Execute(String commandName, params DataParameter[] inputParameters)

 

Function Execute(commandName As String, ParamArray inputParameters As DataParameter()) As Int32

Parameters:

  • commandName:
  • inputParameters:

ExitCriticalSection  protected    (declared in BaseDataAdapter)

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 BaseDataAdapter property to RemoteAdapterStatus.Idle and then releases the critical code section lock.

 

method ExitCriticalSection

 

void ExitCriticalSection()

 

Sub ExitCriticalSection()

FailureBehavior    (declared in BaseDataAdapter)

Gets or sets intended Data Adapter behavior on data update errors.

 

property FailureBehavior: FailureBehavior read write;

 

FailureBehavior FailureBehavior { get; set; }

 

Property FailureBehavior() As FailureBehavior

Fill (DataSet)

 

method Fill(dataset: DataSet)

 

void Fill(DataSet dataset)

 

Sub Fill(dataset As DataSet)

Parameters:

  • dataset:

Fill (DataSet, Boolean)

 

method Fill(dataset: DataSet; applySchema: Boolean)

 

void Fill(DataSet dataset, Boolean applySchema)

 

Sub Fill(dataset As DataSet, applySchema As Boolean)

Parameters:

  • dataset:
  • applySchema:

Fill (DataSet, Schema)

 

method Fill(dataset: DataSet; schema: Schema)

 

void Fill(DataSet dataset, Schema schema)

 

Sub Fill(dataset As DataSet, schema As Schema)

Parameters:

  • dataset:
  • schema:

Fill (DataSet, Schema, Boolean)

 

method Fill(dataset: DataSet; schema: Schema; applySchema: Boolean)

 

void Fill(DataSet dataset, Schema schema, Boolean applySchema)

 

Sub Fill(dataset As DataSet, schema As Schema, applySchema As Boolean)

Parameters:

  • dataset:
  • schema:
  • applySchema:

Fill (DataSet, String, TableRequestInfo)

 

method Fill(dataset: DataSet; tableName: String; tableRequestInfo: TableRequestInfo)

 

void Fill(DataSet dataset, String tableName, TableRequestInfo tableRequestInfo)

 

Sub Fill(dataset As DataSet, tableName As String, tableRequestInfo As TableRequestInfo)

Parameters:

  • dataset:
  • tableName:
  • tableRequestInfo:

Fill (DataSet, String, TableRequestInfo, Boolean)

 

method Fill(dataset: DataSet; tableName: String; tableRequestInfo: TableRequestInfo; applySchema: Boolean)

 

void Fill(DataSet dataset, String tableName, TableRequestInfo tableRequestInfo, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableName As String, tableRequestInfo As TableRequestInfo, applySchema As Boolean)

Parameters:

  • dataset:
  • tableName:
  • tableRequestInfo:
  • applySchema:

Fill (DataSet, array of String)

 

method Fill(dataset: DataSet; tableNames: array of String)

 

void Fill(DataSet dataset, String[] tableNames)

 

Sub Fill(dataset As DataSet, tableNames As String())

Parameters:

  • dataset:
  • tableNames:

Fill (DataSet, array of String, Boolean)

 

method Fill(dataset: DataSet; tableNames: array of String; applySchema: Boolean)

 

void Fill(DataSet dataset, String[] tableNames, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableNames As String(), applySchema As Boolean)

Parameters:

  • dataset:
  • tableNames:
  • applySchema:

Fill (DataSet, array of String, array of TableRequestInfo)

 

method Fill(dataset: DataSet; tableNames: array of String; tableRequestInfo: array of TableRequestInfo)

 

void Fill(DataSet dataset, String[] tableNames, TableRequestInfo[] tableRequestInfo)

 

Sub Fill(dataset As DataSet, tableNames As String(), tableRequestInfo As TableRequestInfo())

Parameters:

  • dataset:
  • tableNames:
  • tableRequestInfo:

Fill (DataSet, array of String, array of TableRequestInfo, Boolean)

 

method Fill(dataset: DataSet; tableNames: array of String; tableRequestInfo: array of TableRequestInfo; applySchema: Boolean)

 

void Fill(DataSet dataset, String[] tableNames, TableRequestInfo[] tableRequestInfo, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableNames As String(), tableRequestInfo As TableRequestInfo(), applySchema As Boolean)

Parameters:

  • dataset:
  • tableNames:
  • tableRequestInfo:
  • applySchema:

Fill (DataSet, array of String, array of WhereExpression)

 

method Fill(dataset: DataSet; tableNames: array of String; whereClauses: array of WhereExpression)

 

void Fill(DataSet dataset, String[] tableNames, WhereExpression[] whereClauses)

 

Sub Fill(dataset As DataSet, tableNames As String(), whereClauses As WhereExpression())

Parameters:

  • dataset:
  • tableNames:
  • whereClauses:

Fill (DataSet, array of String, array of WhereExpression, Boolean)

 

method Fill(dataset: DataSet; tableNames: array of String; whereClauses: array of WhereExpression; applySchema: Boolean)

 

void Fill(DataSet dataset, String[] tableNames, WhereExpression[] whereClauses, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableNames As String(), whereClauses As WhereExpression(), applySchema As Boolean)

Parameters:

  • dataset:
  • tableNames:
  • whereClauses:
  • applySchema:

Fill (DataSet, List<String>)

 

method Fill(dataset: DataSet; tableNames: List<String>)

 

void Fill(DataSet dataset, List<String> tableNames)

 

Sub Fill(dataset As DataSet, tableNames As List<String>)

Parameters:

  • dataset:
  • tableNames:

Fill (DataSet, List<String>, Boolean)

 

method Fill(dataset: DataSet; tableNames: List<String>; applySchema: Boolean)

 

void Fill(DataSet dataset, List<String> tableNames, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableNames As List<String>, applySchema As Boolean)

Parameters:

  • dataset:
  • tableNames:
  • applySchema:

Fill (DataSet, List<String>, List<WhereExpression>)

 

method Fill(dataset: DataSet; tableNames: List<String>; whereClauses: List<WhereExpression>)

 

void Fill(DataSet dataset, List<String> tableNames, List<WhereExpression> whereClauses)

 

Sub Fill(dataset As DataSet, tableNames As List<String>, whereClauses As List<WhereExpression>)

Parameters:

  • dataset:
  • tableNames:
  • whereClauses:

Fill (DataSet, List<String>, List<WhereExpression>, Boolean)

 

method Fill(dataset: DataSet; tableNames: List<String>; whereClauses: List<WhereExpression>; applySchema: Boolean)

 

void Fill(DataSet dataset, List<String> tableNames, List<WhereExpression> whereClauses, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableNames As List<String>, whereClauses As List<WhereExpression>, applySchema As Boolean)

Parameters:

  • dataset:
  • tableNames:
  • whereClauses:
  • applySchema:

Fill (DataTable, TableRequestInfo, Boolean)

 

method Fill(table: DataTable; tableRequestInfo: TableRequestInfo; applySchema: Boolean)

 

void Fill(DataTable table, TableRequestInfo tableRequestInfo, Boolean applySchema)

 

Sub Fill(table As DataTable, tableRequestInfo As TableRequestInfo, applySchema As Boolean)

Parameters:

  • table:
  • tableRequestInfo:
  • applySchema:

Fill (DataTable, WhereExpression, Boolean)

 

method Fill(table: DataTable; whereClause: WhereExpression; applySchema: Boolean)

 

void Fill(DataTable table, WhereExpression whereClause, Boolean applySchema)

 

Sub Fill(table As DataTable, whereClause As WhereExpression, applySchema As Boolean)

Parameters:

  • table:
  • whereClause:
  • applySchema:

FillSchema (DataSet)

 

method FillSchema(dataset: DataSet)

 

void FillSchema(DataSet dataset)

 

Sub FillSchema(dataset As DataSet)

Parameters:

  • dataset:

FillSchema (DataSet, Schema, array of String)

 

method FillSchema(dataset: DataSet; schema: Schema; tableNames: array of String)

 

void FillSchema(DataSet dataset, Schema schema, String[] tableNames)

 

Sub FillSchema(dataset As DataSet, schema As Schema, tableNames As String())

Parameters:

  • dataset:
  • schema:
  • tableNames:

FillSchema (DataSet, Schema, array of SchemaDataTable)

 

method FillSchema(dataset: DataSet; schema: Schema; tables: array of SchemaDataTable)

 

void FillSchema(DataSet dataset, Schema schema, SchemaDataTable[] tables)

 

Sub FillSchema(dataset As DataSet, schema As Schema, tables As SchemaDataTable())

Parameters:

  • dataset:
  • schema:
  • tables:

FillSchema (DataSet, array of String)

 

method FillSchema(dataset: DataSet; tableNames: array of String)

 

void FillSchema(DataSet dataset, String[] tableNames)

 

Sub FillSchema(dataset As DataSet, tableNames As String())

Parameters:

  • dataset:
  • tableNames:

FillSchema (DataSet, List<String>)

 

method FillSchema(dataset: DataSet; tableNames: List<String>)

 

void FillSchema(DataSet dataset, List<String> tableNames)

 

Sub FillSchema(dataset As DataSet, tableNames As List<String>)

Parameters:

  • dataset:
  • tableNames:

FillWithDASql

 

method FillWithDASql(table: DataTable; sql: String; parameters: array of DataParameter)

 

void FillWithDASql(DataTable table, String sql, DataParameter[] parameters)

 

Sub FillWithDASql(table As DataTable, sql As String, parameters As DataParameter())

Parameters:

  • table:
  • sql:
  • parameters:

FlushSchema    (declared in BaseDataAdapter)

Cleans up the Schema cache and sets the BaseDataAdapter to null.

 

method FlushSchema

 

void FlushSchema()

 

Sub FlushSchema()

GetSchemaOnFirstFill    (declared in BaseDataAdapter)

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.

 

property GetSchemaOnFirstFill: Boolean read write;

 

Boolean GetSchemaOnFirstFill { get; set; }

 

Property GetSchemaOnFirstFill() As Boolean

GetSchemaResultIsBinary  protected

Gets a flag indicating whether Schema information is retrieved in a binary form.

Value of this property is used internally to determine appropriate method of processing the retrieved Schema data.

 

property GetSchemaResultIsBinary: Boolean read;

 

Boolean GetSchemaResultIsBinary { get; }

 

ReadOnly Property GetSchemaResultIsBinary() As Boolean

HookupScriptEvents

 

method HookupScriptEvents(table: DataTable)

 

void HookupScriptEvents(DataTable table)

 

Sub HookupScriptEvents(table As DataTable)

Parameters:

  • table:

LoadScripts    (declared in BaseDataAdapter)

Downloads Business Rules Scripting API scripts from the server.

In its current implementation this method downloads entire Schema from the Data Abstract server.

 

method LoadScripts

 

void LoadScripts()

 

Sub LoadScripts()

ReadSchema    (declared in BaseDataAdapter)

Downloads the Schema from the Data Abstract server .

 

method ReadSchema(forceRefresh: Boolean): Schema

 

Schema ReadSchema(Boolean forceRefresh)

 

Function ReadSchema(forceRefresh As Boolean) As Schema

Parameters:

  • forceRefresh: Flag indicating whether Schema should be downloaded even if the Schema is already cached in the Schema property

ReadStreamerSchema  protected    (declared in BaseDataAdapter)

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 BaseDataAdapter method that is called when the server exposes its Schema as Xml).

 

method ReadStreamerSchema: Binary

 

Binary ReadStreamerSchema()

 

Function ReadStreamerSchema() As Binary

Schema    (declared in BaseDataAdapter)

Gets the Schema currently cached by the Data Adapter instance

 

property Schema: Schema read;

 

Schema Schema { get; }

 

ReadOnly Property Schema() As Schema

ScriptProvider    (declared in BaseDataAdapter)

Gets or sets Business Rules Scripting API provided that will be used to execute client-side scripts.

 

property ScriptProvider: IScriptProvider read write;

 

IScriptProvider ScriptProvider { get; set; }

 

Property ScriptProvider() As IScriptProvider

SendFillRequest (DataSet, array of String, array of TableRequestInfo, array of WhereExpression, Boolean, IList<String>)  protected

 

method SendFillRequest(dataset: DataSet; tableNames: array of String; tableRequestInfo: array of TableRequestInfo; whereClauses: array of WhereExpression; applySchema: Boolean; tablesThatNeedSchema: IList<String>)

 

void SendFillRequest(DataSet dataset, String[] tableNames, TableRequestInfo[] tableRequestInfo, WhereExpression[] whereClauses, Boolean applySchema, IList<String> tablesThatNeedSchema)

 

Sub SendFillRequest(dataset As DataSet, tableNames As String(), tableRequestInfo As TableRequestInfo(), whereClauses As WhereExpression(), applySchema As Boolean, tablesThatNeedSchema As IList<String>)

Parameters:

  • dataset:
  • tableNames:
  • tableRequestInfo:
  • whereClauses:
  • applySchema:
  • tablesThatNeedSchema:

SendFillRequest (DataTable, TableRequestInfo, WhereExpression, Boolean)  protected

 

method SendFillRequest(dataset: DataTable; tableRequestInfo: TableRequestInfo; whereClause: WhereExpression; applySchema: Boolean)

 

void SendFillRequest(DataTable dataset, TableRequestInfo tableRequestInfo, WhereExpression whereClause, Boolean applySchema)

 

Sub SendFillRequest(dataset As DataTable, tableRequestInfo As TableRequestInfo, whereClause As WhereExpression, applySchema As Boolean)

Parameters:

  • dataset:
  • tableRequestInfo:
  • whereClause:
  • applySchema:

ShowReconcileDialog

 

event ShowReconcileDialog: ShowReconcleDialogEventHandler;
delegate: method ShowReconcileDialog(sender: Object; e: ShowReconcleDialogEventArgs)

 

delegate ShowReconcleDialogEventHandler ShowReconcileDialog()
delegate: void ShowReconcileDialog(Object sender, ShowReconcleDialogEventArgs e)

 

Event ShowReconcileDialog As ShowReconcleDialogEventHandler
delegate: Sub ShowReconcileDialog(sender As Object, e As ShowReconcleDialogEventArgs)

ShowReconcileRecordInAppUI

 

event ShowReconcileRecordInAppUI: ShowReconcileRecordInAppUIEventHandler;
delegate: method ShowReconcileRecordInAppUI(sender: Object; e: ShowReconcileRecordInAppUIEventArgs)

 

delegate ShowReconcileRecordInAppUIEventHandler ShowReconcileRecordInAppUI()
delegate: void ShowReconcileRecordInAppUI(Object sender, ShowReconcileRecordInAppUIEventArgs e)

 

Event ShowReconcileRecordInAppUI As ShowReconcileRecordInAppUIEventHandler
delegate: Sub ShowReconcileRecordInAppUI(sender As Object, e As ShowReconcileRecordInAppUIEventArgs)

Status    (declared in BaseDataAdapter)

Gets current status of the Data Adapter

 

property Status: DataAdapterStatus read;

 

DataAdapterStatus Status { get; }

 

ReadOnly Property Status() As DataAdapterStatus

TriggerAfterFillDataSet  protected

Raises the AfterFillDataSet event.

 

method TriggerAfterFillDataSet(e: RemoteDataAdapterFillDataSetEventArgs)

 

void TriggerAfterFillDataSet(RemoteDataAdapterFillDataSetEventArgs e)

 

Sub TriggerAfterFillDataSet(e As RemoteDataAdapterFillDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterFillDataTable  protected

 

method TriggerAfterFillDataTable(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerAfterFillDataTable(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerAfterFillDataTable(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e:

TriggerAfterFillDataTableSchema  protected

Raises the AfterFillDataTableSchema event.

 

method TriggerAfterFillDataTableSchema(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerAfterFillDataTableSchema(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerAfterFillDataTableSchema(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterMergeDelta  protected

Raises the AfterMergeDelta event.

 

method TriggerAfterMergeDelta(e: RemoteDataAdapterDataTableDeltaEventArgs)

 

void TriggerAfterMergeDelta(RemoteDataAdapterDataTableDeltaEventArgs e)

 

Sub TriggerAfterMergeDelta(e As RemoteDataAdapterDataTableDeltaEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterUpdateDataSet  protected

Raises the AfterUpdateDataSet event.

 

method TriggerAfterUpdateDataSet(e: RemoteDataAdapterDataSetEventArgs)

 

void TriggerAfterUpdateDataSet(RemoteDataAdapterDataSetEventArgs e)

 

Sub TriggerAfterUpdateDataSet(e As RemoteDataAdapterDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerBeforeFillDataSet  protected

 

method TriggerBeforeFillDataSet(e: RemoteDataAdapterFillDataSetEventArgs)

 

void TriggerBeforeFillDataSet(RemoteDataAdapterFillDataSetEventArgs e)

 

Sub TriggerBeforeFillDataSet(e As RemoteDataAdapterFillDataSetEventArgs)

Parameters:

  • e:

TriggerBeforeFillDataTable  protected

 

method TriggerBeforeFillDataTable(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerBeforeFillDataTable(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerBeforeFillDataTable(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e:

TriggerBeforeMergeDelta  protected

Raises the BeforeMergeDelta event.

 

method TriggerBeforeMergeDelta(e: RemoteDataAdapterDataTableDeltaEventArgs)

 

void TriggerBeforeMergeDelta(RemoteDataAdapterDataTableDeltaEventArgs e)

 

Sub TriggerBeforeMergeDelta(e As RemoteDataAdapterDataTableDeltaEventArgs)

Parameters:

  • e: Event arguments

TriggerBeforeUpdateDataSet  protected

Raises the BeforeUpdateDataSet event.

 

method TriggerBeforeUpdateDataSet(e: RemoteDataAdapterDataSetEventArgs)

 

void TriggerBeforeUpdateDataSet(RemoteDataAdapterDataSetEventArgs e)

 

Sub TriggerBeforeUpdateDataSet(e As RemoteDataAdapterDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerUpdateFailure  protected

 

method TriggerUpdateFailure(e: RemoteDataAdapterUpdateFailureEventArgs)

 

void TriggerUpdateFailure(RemoteDataAdapterUpdateFailureEventArgs e)

 

Sub TriggerUpdateFailure(e As RemoteDataAdapterUpdateFailureEventArgs)

Parameters:

  • e:

UnHookScriptEvents

 

method UnHookScriptEvents(table: DataTable)

 

void UnHookScriptEvents(DataTable table)

 

Sub UnHookScriptEvents(table As DataTable)

Parameters:

  • table:

Update (DataSet)

 

method Update(dataset: DataSet)

 

void Update(DataSet dataset)

 

Sub Update(dataset As DataSet)

Parameters:

  • dataset:

Update (DataSet, array of String)

 

method Update(dataset: DataSet; tableNames: array of String)

 

void Update(DataSet dataset, String[] tableNames)

 

Sub Update(dataset As DataSet, tableNames As String())

Parameters:

  • dataset:
  • tableNames:

Update (array of Delta)

 

method Update(deltas: array of Delta)

 

void Update(Delta[] deltas)

 

Sub Update(deltas As Delta())

Parameters:

  • deltas:

Update (array of Delta, Boolean)

 

method Update(deltas: array of Delta; ignoreErrors: Boolean)

 

void Update(Delta[] deltas, Boolean ignoreErrors)

 

Sub Update(deltas As Delta(), ignoreErrors As Boolean)

Parameters:

  • deltas:
  • ignoreErrors:

UpdateFailure

This event is raised once the process of applying changes to the server has failed.

 

event UpdateFailure: EventHandler<RemoteDataAdapterUpdateFailureEventArgs>;

 

delegate EventHandler<RemoteDataAdapterUpdateFailureEventArgs> UpdateFailure()

 

Event UpdateFailure As EventHandler<RemoteDataAdapterUpdateFailureEventArgs>

 

AcceptChangesDuringFill    (declared in BaseDataAdapter)

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.

 

property AcceptChangesDuringFill: Boolean read write;

 

Boolean AcceptChangesDuringFill { get; set; }

 

Property AcceptChangesDuringFill() As Boolean

AcceptChangesDuringUpdate    (declared in BaseDataAdapter)

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.

 

property AcceptChangesDuringUpdate: Boolean read write;

 

Boolean AcceptChangesDuringUpdate { get; set; }

 

Property AcceptChangesDuringUpdate() As Boolean

AutoLoadScripts    (declared in BaseDataAdapter)

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.

 

property AutoLoadScripts: Boolean read write;

 

Boolean AutoLoadScripts { get; set; }

 

Property AutoLoadScripts() As Boolean

CacheSchema    (declared in BaseDataAdapter)

Gets or sets flag indicating whether Schema retrieved from the server via the BaseDataAdapter method call should be chached in the BaseDataAdapter property. Setting this property to false can significantly decrease performance.

The default value is true.

 

property CacheSchema: Boolean read write;

 

Boolean CacheSchema { get; set; }

 

Property CacheSchema() As Boolean

DynamicSelect    (declared in BaseDataAdapter)

Gets or sets a flag indicating whether Data Adapter should perform queries using the Dynamic Select feature

 

property DynamicSelect: Boolean read write;

 

Boolean DynamicSelect { get; set; }

 

Property DynamicSelect() As Boolean

FailureBehavior    (declared in BaseDataAdapter)

Gets or sets intended Data Adapter behavior on data update errors.

 

property FailureBehavior: FailureBehavior read write;

 

FailureBehavior FailureBehavior { get; set; }

 

Property FailureBehavior() As FailureBehavior

GetSchemaOnFirstFill    (declared in BaseDataAdapter)

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.

 

property GetSchemaOnFirstFill: Boolean read write;

 

Boolean GetSchemaOnFirstFill { get; set; }

 

Property GetSchemaOnFirstFill() As Boolean

GetSchemaResultIsBinary  protected

Gets a flag indicating whether Schema information is retrieved in a binary form.

Value of this property is used internally to determine appropriate method of processing the retrieved Schema data.

 

property GetSchemaResultIsBinary: Boolean read;

 

Boolean GetSchemaResultIsBinary { get; }

 

ReadOnly Property GetSchemaResultIsBinary() As Boolean

Schema    (declared in BaseDataAdapter)

Gets the Schema currently cached by the Data Adapter instance

 

property Schema: Schema read;

 

Schema Schema { get; }

 

ReadOnly Property Schema() As Schema

ScriptProvider    (declared in BaseDataAdapter)

Gets or sets Business Rules Scripting API provided that will be used to execute client-side scripts.

 

property ScriptProvider: IScriptProvider read write;

 

IScriptProvider ScriptProvider { get; set; }

 

Property ScriptProvider() As IScriptProvider

Status    (declared in BaseDataAdapter)

Gets current status of the Data Adapter

 

property Status: DataAdapterStatus read;

 

DataAdapterStatus Status { get; }

 

ReadOnly Property Status() As DataAdapterStatus

 

constructor  protected

Creates a new instance of the DataAdapter class.

Cannot be called directly.

 

constructor

 

DataAdapter()

 

Sub New()

constructor (Boolean)  protected

 

constructor(avoidLicenseCheck: Boolean)

 

DataAdapter(Boolean avoidLicenseCheck)

 

Sub New(avoidLicenseCheck As Boolean)

Parameters:

  • avoidLicenseCheck:

constructor (IContainer)  protected

Creates a new instance of the DataAdapter class and adds it to the provided components container.

Cannot be called directly.

 

constructor(container: IContainer)

 

DataAdapter(IContainer container)

 

Sub New(container As IContainer)

Parameters:

  • container: Components container

BeginInit    (declared in BaseDataAdapter)

 

method BeginInit

 

void BeginInit()

 

Sub BeginInit()

BeginInternalUpdate  protected    (declared in BaseDataAdapter)

Starts asynchronous data update operation.

 

method BeginInternalUpdate(deltas: array of Delta; cb: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginInternalUpdate(Delta[] deltas, AsyncCallback cb, Object state)

 

Function BeginInternalUpdate(deltas As Delta(), cb As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • deltas: Collection of Delta instances that will be send to the Data Abstract server
  • cb: Callback method that will be called once the asynchronous data update call is completed
  • state: Asynchronous operation state object

CheckAdapterSettings  protected    (declared in BaseDataAdapter)

Performs required internal data adapter initialization before issuing a data read or update request.

 

method CheckAdapterSettings

 

void CheckAdapterSettings()

 

Sub CheckAdapterSettings()

CheckFailures  protected    (declared in BaseDataAdapter)

Composes the data update failure message based on the Delta information returned from the server after the Udate call.

 

method CheckFailures(delta: Delta; changes: List<DeltaChange>; failureMessage: StringBuilder)

 

void CheckFailures(Delta delta, List<DeltaChange> changes, StringBuilder failureMessage)

 

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
  • failureMessage: String builder instace that will contain composed data update failure message

EndInit    (declared in BaseDataAdapter)

 

method EndInit

 

void EndInit()

 

Sub EndInit()

EndInternalUpdate  protected    (declared in BaseDataAdapter)

Finishes the asynchronous data update operation and performs needed cleanup actions, f.e. merges back updated AutoInc values retrieved from the server.

 

method EndInternalUpdate(ar: IAsyncResult)

 

void EndInternalUpdate(IAsyncResult ar)

 

Sub EndInternalUpdate(ar As IAsyncResult)

Parameters:

  • ar: Object representing the status of an asynchronous operation

EnterCriticalSection  protected    (declared in BaseDataAdapter)

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.

 

method EnterCriticalSection(status: DataAdapterStatus)

 

void EnterCriticalSection(DataAdapterStatus status)

 

Sub EnterCriticalSection(status As DataAdapterStatus)

Parameters:

  • status: Value that should be assigned to the BaseDataAdapter property until the critical code section is exited

Execute (String): Int32    (declared in BaseDataAdapter)

 

method Execute(commandName: String): Int32

 

Int32 Execute(String commandName)

 

Function Execute(commandName As String) As Int32

Parameters:

  • commandName:

Execute (String, array of Object, DataParameter): Int32    (declared in BaseDataAdapter)

 

method Execute(commandName: String; inputParameters: array of Object; out outputParameterts: DataParameter): Int32

 

Int32 Execute(String commandName, Object[] inputParameters, out DataParameter outputParameterts)

 

Function Execute(commandName As String, inputParameters As Object(), <OutAttribute> ByRef outputParameterts As DataParameter) As Int32

Parameters:

  • commandName:
  • inputParameters:
  • outputParameterts:

Execute (String, array of DataParameter, DataParameter): Int32    (declared in BaseDataAdapter)

 

method Execute(commandName: String; inputParameters: array of DataParameter; out outputParameterts: DataParameter): Int32

 

Int32 Execute(String commandName, DataParameter[] inputParameters, out DataParameter outputParameterts)

 

Function Execute(commandName As String, inputParameters As DataParameter(), <OutAttribute> ByRef outputParameterts As DataParameter) As Int32

Parameters:

  • commandName:
  • inputParameters:
  • outputParameterts:

Execute (String, array of Object): Int32    (declared in BaseDataAdapter)

 

method Execute(commandName: String; params inputParameters: array of Object): Int32

 

Int32 Execute(String commandName, params Object[] inputParameters)

 

Function Execute(commandName As String, ParamArray inputParameters As Object()) As Int32

Parameters:

  • commandName:
  • inputParameters:

Execute (String, array of DataParameter): Int32    (declared in BaseDataAdapter)

 

method Execute(commandName: String; params inputParameters: array of DataParameter): Int32

 

Int32 Execute(String commandName, params DataParameter[] inputParameters)

 

Function Execute(commandName As String, ParamArray inputParameters As DataParameter()) As Int32

Parameters:

  • commandName:
  • inputParameters:

ExitCriticalSection  protected    (declared in BaseDataAdapter)

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 BaseDataAdapter property to RemoteAdapterStatus.Idle and then releases the critical code section lock.

 

method ExitCriticalSection

 

void ExitCriticalSection()

 

Sub ExitCriticalSection()

Fill (DataSet)

 

method Fill(dataset: DataSet)

 

void Fill(DataSet dataset)

 

Sub Fill(dataset As DataSet)

Parameters:

  • dataset:

Fill (DataSet, Boolean)

 

method Fill(dataset: DataSet; applySchema: Boolean)

 

void Fill(DataSet dataset, Boolean applySchema)

 

Sub Fill(dataset As DataSet, applySchema As Boolean)

Parameters:

  • dataset:
  • applySchema:

Fill (DataSet, Schema)

 

method Fill(dataset: DataSet; schema: Schema)

 

void Fill(DataSet dataset, Schema schema)

 

Sub Fill(dataset As DataSet, schema As Schema)

Parameters:

  • dataset:
  • schema:

Fill (DataSet, Schema, Boolean)

 

method Fill(dataset: DataSet; schema: Schema; applySchema: Boolean)

 

void Fill(DataSet dataset, Schema schema, Boolean applySchema)

 

Sub Fill(dataset As DataSet, schema As Schema, applySchema As Boolean)

Parameters:

  • dataset:
  • schema:
  • applySchema:

Fill (DataSet, String, TableRequestInfo)

 

method Fill(dataset: DataSet; tableName: String; tableRequestInfo: TableRequestInfo)

 

void Fill(DataSet dataset, String tableName, TableRequestInfo tableRequestInfo)

 

Sub Fill(dataset As DataSet, tableName As String, tableRequestInfo As TableRequestInfo)

Parameters:

  • dataset:
  • tableName:
  • tableRequestInfo:

Fill (DataSet, String, TableRequestInfo, Boolean)

 

method Fill(dataset: DataSet; tableName: String; tableRequestInfo: TableRequestInfo; applySchema: Boolean)

 

void Fill(DataSet dataset, String tableName, TableRequestInfo tableRequestInfo, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableName As String, tableRequestInfo As TableRequestInfo, applySchema As Boolean)

Parameters:

  • dataset:
  • tableName:
  • tableRequestInfo:
  • applySchema:

Fill (DataSet, array of String)

 

method Fill(dataset: DataSet; tableNames: array of String)

 

void Fill(DataSet dataset, String[] tableNames)

 

Sub Fill(dataset As DataSet, tableNames As String())

Parameters:

  • dataset:
  • tableNames:

Fill (DataSet, array of String, Boolean)

 

method Fill(dataset: DataSet; tableNames: array of String; applySchema: Boolean)

 

void Fill(DataSet dataset, String[] tableNames, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableNames As String(), applySchema As Boolean)

Parameters:

  • dataset:
  • tableNames:
  • applySchema:

Fill (DataSet, array of String, array of TableRequestInfo)

 

method Fill(dataset: DataSet; tableNames: array of String; tableRequestInfo: array of TableRequestInfo)

 

void Fill(DataSet dataset, String[] tableNames, TableRequestInfo[] tableRequestInfo)

 

Sub Fill(dataset As DataSet, tableNames As String(), tableRequestInfo As TableRequestInfo())

Parameters:

  • dataset:
  • tableNames:
  • tableRequestInfo:

Fill (DataSet, array of String, array of TableRequestInfo, Boolean)

 

method Fill(dataset: DataSet; tableNames: array of String; tableRequestInfo: array of TableRequestInfo; applySchema: Boolean)

 

void Fill(DataSet dataset, String[] tableNames, TableRequestInfo[] tableRequestInfo, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableNames As String(), tableRequestInfo As TableRequestInfo(), applySchema As Boolean)

Parameters:

  • dataset:
  • tableNames:
  • tableRequestInfo:
  • applySchema:

Fill (DataSet, array of String, array of WhereExpression)

 

method Fill(dataset: DataSet; tableNames: array of String; whereClauses: array of WhereExpression)

 

void Fill(DataSet dataset, String[] tableNames, WhereExpression[] whereClauses)

 

Sub Fill(dataset As DataSet, tableNames As String(), whereClauses As WhereExpression())

Parameters:

  • dataset:
  • tableNames:
  • whereClauses:

Fill (DataSet, array of String, array of WhereExpression, Boolean)

 

method Fill(dataset: DataSet; tableNames: array of String; whereClauses: array of WhereExpression; applySchema: Boolean)

 

void Fill(DataSet dataset, String[] tableNames, WhereExpression[] whereClauses, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableNames As String(), whereClauses As WhereExpression(), applySchema As Boolean)

Parameters:

  • dataset:
  • tableNames:
  • whereClauses:
  • applySchema:

Fill (DataSet, List<String>)

 

method Fill(dataset: DataSet; tableNames: List<String>)

 

void Fill(DataSet dataset, List<String> tableNames)

 

Sub Fill(dataset As DataSet, tableNames As List<String>)

Parameters:

  • dataset:
  • tableNames:

Fill (DataSet, List<String>, Boolean)

 

method Fill(dataset: DataSet; tableNames: List<String>; applySchema: Boolean)

 

void Fill(DataSet dataset, List<String> tableNames, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableNames As List<String>, applySchema As Boolean)

Parameters:

  • dataset:
  • tableNames:
  • applySchema:

Fill (DataSet, List<String>, List<WhereExpression>)

 

method Fill(dataset: DataSet; tableNames: List<String>; whereClauses: List<WhereExpression>)

 

void Fill(DataSet dataset, List<String> tableNames, List<WhereExpression> whereClauses)

 

Sub Fill(dataset As DataSet, tableNames As List<String>, whereClauses As List<WhereExpression>)

Parameters:

  • dataset:
  • tableNames:
  • whereClauses:

Fill (DataSet, List<String>, List<WhereExpression>, Boolean)

 

method Fill(dataset: DataSet; tableNames: List<String>; whereClauses: List<WhereExpression>; applySchema: Boolean)

 

void Fill(DataSet dataset, List<String> tableNames, List<WhereExpression> whereClauses, Boolean applySchema)

 

Sub Fill(dataset As DataSet, tableNames As List<String>, whereClauses As List<WhereExpression>, applySchema As Boolean)

Parameters:

  • dataset:
  • tableNames:
  • whereClauses:
  • applySchema:

Fill (DataTable, TableRequestInfo, Boolean)

 

method Fill(table: DataTable; tableRequestInfo: TableRequestInfo; applySchema: Boolean)

 

void Fill(DataTable table, TableRequestInfo tableRequestInfo, Boolean applySchema)

 

Sub Fill(table As DataTable, tableRequestInfo As TableRequestInfo, applySchema As Boolean)

Parameters:

  • table:
  • tableRequestInfo:
  • applySchema:

Fill (DataTable, WhereExpression, Boolean)

 

method Fill(table: DataTable; whereClause: WhereExpression; applySchema: Boolean)

 

void Fill(DataTable table, WhereExpression whereClause, Boolean applySchema)

 

Sub Fill(table As DataTable, whereClause As WhereExpression, applySchema As Boolean)

Parameters:

  • table:
  • whereClause:
  • applySchema:

FillSchema (DataSet)

 

method FillSchema(dataset: DataSet)

 

void FillSchema(DataSet dataset)

 

Sub FillSchema(dataset As DataSet)

Parameters:

  • dataset:

FillSchema (DataSet, Schema, array of String)

 

method FillSchema(dataset: DataSet; schema: Schema; tableNames: array of String)

 

void FillSchema(DataSet dataset, Schema schema, String[] tableNames)

 

Sub FillSchema(dataset As DataSet, schema As Schema, tableNames As String())

Parameters:

  • dataset:
  • schema:
  • tableNames:

FillSchema (DataSet, Schema, array of SchemaDataTable)

 

method FillSchema(dataset: DataSet; schema: Schema; tables: array of SchemaDataTable)

 

void FillSchema(DataSet dataset, Schema schema, SchemaDataTable[] tables)

 

Sub FillSchema(dataset As DataSet, schema As Schema, tables As SchemaDataTable())

Parameters:

  • dataset:
  • schema:
  • tables:

FillSchema (DataSet, array of String)

 

method FillSchema(dataset: DataSet; tableNames: array of String)

 

void FillSchema(DataSet dataset, String[] tableNames)

 

Sub FillSchema(dataset As DataSet, tableNames As String())

Parameters:

  • dataset:
  • tableNames:

FillSchema (DataSet, List<String>)

 

method FillSchema(dataset: DataSet; tableNames: List<String>)

 

void FillSchema(DataSet dataset, List<String> tableNames)

 

Sub FillSchema(dataset As DataSet, tableNames As List<String>)

Parameters:

  • dataset:
  • tableNames:

FillWithDASql

 

method FillWithDASql(table: DataTable; sql: String; parameters: array of DataParameter)

 

void FillWithDASql(DataTable table, String sql, DataParameter[] parameters)

 

Sub FillWithDASql(table As DataTable, sql As String, parameters As DataParameter())

Parameters:

  • table:
  • sql:
  • parameters:

FlushSchema    (declared in BaseDataAdapter)

Cleans up the Schema cache and sets the BaseDataAdapter to null.

 

method FlushSchema

 

void FlushSchema()

 

Sub FlushSchema()

HookupScriptEvents

 

method HookupScriptEvents(table: DataTable)

 

void HookupScriptEvents(DataTable table)

 

Sub HookupScriptEvents(table As DataTable)

Parameters:

  • table:

LoadScripts    (declared in BaseDataAdapter)

Downloads Business Rules Scripting API scripts from the server.

In its current implementation this method downloads entire Schema from the Data Abstract server.

 

method LoadScripts

 

void LoadScripts()

 

Sub LoadScripts()

ReadSchema    (declared in BaseDataAdapter)

Downloads the Schema from the Data Abstract server .

 

method ReadSchema(forceRefresh: Boolean): Schema

 

Schema ReadSchema(Boolean forceRefresh)

 

Function ReadSchema(forceRefresh As Boolean) As Schema

Parameters:

  • forceRefresh: Flag indicating whether Schema should be downloaded even if the Schema is already cached in the Schema property

ReadStreamerSchema  protected    (declared in BaseDataAdapter)

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 BaseDataAdapter method that is called when the server exposes its Schema as Xml).

 

method ReadStreamerSchema: Binary

 

Binary ReadStreamerSchema()

 

Function ReadStreamerSchema() As Binary

SendFillRequest (DataSet, array of String, array of TableRequestInfo, array of WhereExpression, Boolean, IList<String>)  protected

 

method SendFillRequest(dataset: DataSet; tableNames: array of String; tableRequestInfo: array of TableRequestInfo; whereClauses: array of WhereExpression; applySchema: Boolean; tablesThatNeedSchema: IList<String>)

 

void SendFillRequest(DataSet dataset, String[] tableNames, TableRequestInfo[] tableRequestInfo, WhereExpression[] whereClauses, Boolean applySchema, IList<String> tablesThatNeedSchema)

 

Sub SendFillRequest(dataset As DataSet, tableNames As String(), tableRequestInfo As TableRequestInfo(), whereClauses As WhereExpression(), applySchema As Boolean, tablesThatNeedSchema As IList<String>)

Parameters:

  • dataset:
  • tableNames:
  • tableRequestInfo:
  • whereClauses:
  • applySchema:
  • tablesThatNeedSchema:

SendFillRequest (DataTable, TableRequestInfo, WhereExpression, Boolean)  protected

 

method SendFillRequest(dataset: DataTable; tableRequestInfo: TableRequestInfo; whereClause: WhereExpression; applySchema: Boolean)

 

void SendFillRequest(DataTable dataset, TableRequestInfo tableRequestInfo, WhereExpression whereClause, Boolean applySchema)

 

Sub SendFillRequest(dataset As DataTable, tableRequestInfo As TableRequestInfo, whereClause As WhereExpression, applySchema As Boolean)

Parameters:

  • dataset:
  • tableRequestInfo:
  • whereClause:
  • applySchema:

TriggerAfterFillDataSet  protected

Raises the AfterFillDataSet event.

 

method TriggerAfterFillDataSet(e: RemoteDataAdapterFillDataSetEventArgs)

 

void TriggerAfterFillDataSet(RemoteDataAdapterFillDataSetEventArgs e)

 

Sub TriggerAfterFillDataSet(e As RemoteDataAdapterFillDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterFillDataTable  protected

 

method TriggerAfterFillDataTable(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerAfterFillDataTable(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerAfterFillDataTable(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e:

TriggerAfterFillDataTableSchema  protected

Raises the AfterFillDataTableSchema event.

 

method TriggerAfterFillDataTableSchema(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerAfterFillDataTableSchema(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerAfterFillDataTableSchema(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterMergeDelta  protected

Raises the AfterMergeDelta event.

 

method TriggerAfterMergeDelta(e: RemoteDataAdapterDataTableDeltaEventArgs)

 

void TriggerAfterMergeDelta(RemoteDataAdapterDataTableDeltaEventArgs e)

 

Sub TriggerAfterMergeDelta(e As RemoteDataAdapterDataTableDeltaEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterUpdateDataSet  protected

Raises the AfterUpdateDataSet event.

 

method TriggerAfterUpdateDataSet(e: RemoteDataAdapterDataSetEventArgs)

 

void TriggerAfterUpdateDataSet(RemoteDataAdapterDataSetEventArgs e)

 

Sub TriggerAfterUpdateDataSet(e As RemoteDataAdapterDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerBeforeFillDataSet  protected

 

method TriggerBeforeFillDataSet(e: RemoteDataAdapterFillDataSetEventArgs)

 

void TriggerBeforeFillDataSet(RemoteDataAdapterFillDataSetEventArgs e)

 

Sub TriggerBeforeFillDataSet(e As RemoteDataAdapterFillDataSetEventArgs)

Parameters:

  • e:

TriggerBeforeFillDataTable  protected

 

method TriggerBeforeFillDataTable(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerBeforeFillDataTable(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerBeforeFillDataTable(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e:

TriggerBeforeMergeDelta  protected

Raises the BeforeMergeDelta event.

 

method TriggerBeforeMergeDelta(e: RemoteDataAdapterDataTableDeltaEventArgs)

 

void TriggerBeforeMergeDelta(RemoteDataAdapterDataTableDeltaEventArgs e)

 

Sub TriggerBeforeMergeDelta(e As RemoteDataAdapterDataTableDeltaEventArgs)

Parameters:

  • e: Event arguments

TriggerBeforeUpdateDataSet  protected

Raises the BeforeUpdateDataSet event.

 

method TriggerBeforeUpdateDataSet(e: RemoteDataAdapterDataSetEventArgs)

 

void TriggerBeforeUpdateDataSet(RemoteDataAdapterDataSetEventArgs e)

 

Sub TriggerBeforeUpdateDataSet(e As RemoteDataAdapterDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerUpdateFailure  protected

 

method TriggerUpdateFailure(e: RemoteDataAdapterUpdateFailureEventArgs)

 

void TriggerUpdateFailure(RemoteDataAdapterUpdateFailureEventArgs e)

 

Sub TriggerUpdateFailure(e As RemoteDataAdapterUpdateFailureEventArgs)

Parameters:

  • e:

UnHookScriptEvents

 

method UnHookScriptEvents(table: DataTable)

 

void UnHookScriptEvents(DataTable table)

 

Sub UnHookScriptEvents(table As DataTable)

Parameters:

  • table:

Update (DataSet)

 

method Update(dataset: DataSet)

 

void Update(DataSet dataset)

 

Sub Update(dataset As DataSet)

Parameters:

  • dataset:

Update (DataSet, array of String)

 

method Update(dataset: DataSet; tableNames: array of String)

 

void Update(DataSet dataset, String[] tableNames)

 

Sub Update(dataset As DataSet, tableNames As String())

Parameters:

  • dataset:
  • tableNames:

Update (array of Delta)

 

method Update(deltas: array of Delta)

 

void Update(Delta[] deltas)

 

Sub Update(deltas As Delta())

Parameters:

  • deltas:

Update (array of Delta, Boolean)

 

method Update(deltas: array of Delta; ignoreErrors: Boolean)

 

void Update(Delta[] deltas, Boolean ignoreErrors)

 

Sub Update(deltas As Delta(), ignoreErrors As Boolean)

Parameters:

  • deltas:
  • ignoreErrors:

 

AfterFillDataSet

 

event AfterFillDataSet: RemoteDataAdapterFillDataSetEventHandler;
delegate: method AfterFillDataSet(sender: Object; e: RemoteDataAdapterFillDataSetEventArgs)

 

delegate RemoteDataAdapterFillDataSetEventHandler AfterFillDataSet()
delegate: void AfterFillDataSet(Object sender, RemoteDataAdapterFillDataSetEventArgs e)

 

Event AfterFillDataSet As RemoteDataAdapterFillDataSetEventHandler
delegate: Sub AfterFillDataSet(sender As Object, e As RemoteDataAdapterFillDataSetEventArgs)

AfterFillDataTable

 

event AfterFillDataTable: RemoteDataAdapterDataTableEventHandler;
delegate: method AfterFillDataTable(sender: Object; e: RemoteDataAdapterDataTableEventArgs)

 

delegate RemoteDataAdapterDataTableEventHandler AfterFillDataTable()
delegate: void AfterFillDataTable(Object sender, RemoteDataAdapterDataTableEventArgs e)

 

Event AfterFillDataTable As RemoteDataAdapterDataTableEventHandler
delegate: Sub AfterFillDataTable(sender As Object, e As RemoteDataAdapterDataTableEventArgs)

AfterFillDataTableSchema

This event is raised once a DataTable defined in the Schema has been added to the target DataSet.

This event can be used to fine-tune the added DataTable.

 

event AfterFillDataTableSchema: RemoteDataAdapterDataTableEventHandler;
delegate: method AfterFillDataTableSchema(sender: Object; e: RemoteDataAdapterDataTableEventArgs)

 

delegate RemoteDataAdapterDataTableEventHandler AfterFillDataTableSchema()
delegate: void AfterFillDataTableSchema(Object sender, RemoteDataAdapterDataTableEventArgs e)

 

Event AfterFillDataTableSchema As RemoteDataAdapterDataTableEventHandler
delegate: Sub AfterFillDataTableSchema(sender As Object, e As RemoteDataAdapterDataTableEventArgs)

AfterMergeDelta

This event is raised when changes contained in a Delta have been merged back into the DataSet.

 

event AfterMergeDelta: RemoteDataAdapterDataTableDeltaEventHandler;
delegate: method AfterMergeDelta(sender: Object; e: RemoteDataAdapterDataTableDeltaEventArgs)

 

delegate RemoteDataAdapterDataTableDeltaEventHandler AfterMergeDelta()
delegate: void AfterMergeDelta(Object sender, RemoteDataAdapterDataTableDeltaEventArgs e)

 

Event AfterMergeDelta As RemoteDataAdapterDataTableDeltaEventHandler
delegate: Sub AfterMergeDelta(sender As Object, e As RemoteDataAdapterDataTableDeltaEventArgs)

AfterUpdateDataSet

This event is raised once the process of applying changes to the server has been successfully completed.

 

event AfterUpdateDataSet: RemoteDataAdapterDataSetEventHandler;
delegate: method AfterUpdateDataSet(sender: Object; e: RemoteDataAdapterDataSetEventArgs)

 

delegate RemoteDataAdapterDataSetEventHandler AfterUpdateDataSet()
delegate: void AfterUpdateDataSet(Object sender, RemoteDataAdapterDataSetEventArgs e)

 

Event AfterUpdateDataSet As RemoteDataAdapterDataSetEventHandler
delegate: Sub AfterUpdateDataSet(sender As Object, e As RemoteDataAdapterDataSetEventArgs)

BeforeFillDataSet

 

event BeforeFillDataSet: RemoteDataAdapterFillDataSetEventHandler;
delegate: method BeforeFillDataSet(sender: Object; e: RemoteDataAdapterFillDataSetEventArgs)

 

delegate RemoteDataAdapterFillDataSetEventHandler BeforeFillDataSet()
delegate: void BeforeFillDataSet(Object sender, RemoteDataAdapterFillDataSetEventArgs e)

 

Event BeforeFillDataSet As RemoteDataAdapterFillDataSetEventHandler
delegate: Sub BeforeFillDataSet(sender As Object, e As RemoteDataAdapterFillDataSetEventArgs)

BeforeFillDataTable

 

event BeforeFillDataTable: RemoteDataAdapterDataTableEventHandler;
delegate: method BeforeFillDataTable(sender: Object; e: RemoteDataAdapterDataTableEventArgs)

 

delegate RemoteDataAdapterDataTableEventHandler BeforeFillDataTable()
delegate: void BeforeFillDataTable(Object sender, RemoteDataAdapterDataTableEventArgs e)

 

Event BeforeFillDataTable As RemoteDataAdapterDataTableEventHandler
delegate: Sub BeforeFillDataTable(sender As Object, e As RemoteDataAdapterDataTableEventArgs)

BeforeMergeDelta

This event is raised when changes contained in a Delta have been received from the server and are ready to be merged back into the DataSet.

 

event BeforeMergeDelta: RemoteDataAdapterDataTableDeltaEventHandler;
delegate: method BeforeMergeDelta(sender: Object; e: RemoteDataAdapterDataTableDeltaEventArgs)

 

delegate RemoteDataAdapterDataTableDeltaEventHandler BeforeMergeDelta()
delegate: void BeforeMergeDelta(Object sender, RemoteDataAdapterDataTableDeltaEventArgs e)

 

Event BeforeMergeDelta As RemoteDataAdapterDataTableDeltaEventHandler
delegate: Sub BeforeMergeDelta(sender As Object, e As RemoteDataAdapterDataTableDeltaEventArgs)

BeforeUpdateDataSet

This event is raised before data changes are applied to the server.

This event can be used to fine-tune the added data.

 

event BeforeUpdateDataSet: RemoteDataAdapterDataSetEventHandler;
delegate: method BeforeUpdateDataSet(sender: Object; e: RemoteDataAdapterDataSetEventArgs)

 

delegate RemoteDataAdapterDataSetEventHandler BeforeUpdateDataSet()
delegate: void BeforeUpdateDataSet(Object sender, RemoteDataAdapterDataSetEventArgs e)

 

Event BeforeUpdateDataSet As RemoteDataAdapterDataSetEventHandler
delegate: Sub BeforeUpdateDataSet(sender As Object, e As RemoteDataAdapterDataSetEventArgs)

ShowReconcileDialog

 

event ShowReconcileDialog: ShowReconcleDialogEventHandler;
delegate: method ShowReconcileDialog(sender: Object; e: ShowReconcleDialogEventArgs)

 

delegate ShowReconcleDialogEventHandler ShowReconcileDialog()
delegate: void ShowReconcileDialog(Object sender, ShowReconcleDialogEventArgs e)

 

Event ShowReconcileDialog As ShowReconcleDialogEventHandler
delegate: Sub ShowReconcileDialog(sender As Object, e As ShowReconcleDialogEventArgs)

ShowReconcileRecordInAppUI

 

event ShowReconcileRecordInAppUI: ShowReconcileRecordInAppUIEventHandler;
delegate: method ShowReconcileRecordInAppUI(sender: Object; e: ShowReconcileRecordInAppUIEventArgs)

 

delegate ShowReconcileRecordInAppUIEventHandler ShowReconcileRecordInAppUI()
delegate: void ShowReconcileRecordInAppUI(Object sender, ShowReconcileRecordInAppUIEventArgs e)

 

Event ShowReconcileRecordInAppUI As ShowReconcileRecordInAppUIEventHandler
delegate: Sub ShowReconcileRecordInAppUI(sender As Object, e As ShowReconcileRecordInAppUIEventArgs)

UpdateFailure

This event is raised once the process of applying changes to the server has failed.

 

event UpdateFailure: EventHandler<RemoteDataAdapterUpdateFailureEventArgs>;

 

delegate EventHandler<RemoteDataAdapterUpdateFailureEventArgs> UpdateFailure()

 

Event UpdateFailure As EventHandler<RemoteDataAdapterUpdateFailureEventArgs>