RemoteDataAdapter

Overview

Represents client-side access to a set of data tables published on the server.

It's similar to the other DataAdapter descendants provided by the .NET Framework (SqlDataAdapter, OleDbDataAdapter, etc) and you can use it to retrieve schema information, to fill a DataSet with data from the server or to apply local updates back to the server.

The RemoteDataAdapter supports Dynamic Method Binding to give you tight control over how methods are invoked on the remote server to fetch or apply data. By default, a newly instantiated RemoteDataAdapter is configured for the standard methods provided by Data Abstract 4.0 servers, as defined in IDataAbstractService, but you can manually adjust its DataRequestCall, DataUpdateCall and SchemaCall properties to control the calls that are made.

Location

 

constructor

 

constructor

 

RemoteDataAdapter()

 

Sub New()

constructor (Boolean)  protected    (declared in DataAdapter)

 

constructor(avoidLicenseCheck: Boolean)

 

RemoteDataAdapter(Boolean avoidLicenseCheck)

 

Sub New(avoidLicenseCheck As Boolean)

Parameters:

  • avoidLicenseCheck:

constructor (IContainer)

 

constructor(container: IContainer)

 

RemoteDataAdapter(IContainer container)

 

Sub New(container As IContainer)

Parameters:

  • container:

constructor (String)

 

constructor(targetUrl: String)

 

RemoteDataAdapter(String targetUrl)

 

Sub New(targetUrl As String)

Parameters:

  • targetUrl:

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    (declared in DataAdapter)

 

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    (declared in DataAdapter)

 

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    (declared in DataAdapter)

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    (declared in DataAdapter)

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    (declared in DataAdapter)

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    (declared in DataAdapter)

 

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    (declared in DataAdapter)

 

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    (declared in DataAdapter)

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    (declared in DataAdapter)

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 (array of Delta, AsyncCallback, Object): IAsyncResult  protected

 

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

 

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

 

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

Parameters:

  • deltas:
  • callback:
  • state:

BeginInternalUpdate (array of Delta, AsyncCallback, Object): IAsyncResult  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

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

DataRequestCall

Defines the remove service call that will be executed to Fill a dataset with data from the remote server. By default, it will be mapped to the GetData call as defined in the IDataAbstractService interface implemented by standard Data Abstract 4.0 servers, but you can change its sub-properties to control how the data request call is made, if you are using a custom server interface.

 

property DataRequestCall: DataRequestRequest read;

 

DataRequestRequest DataRequestCall { get; }

 

ReadOnly Property DataRequestCall() As DataRequestRequest

DataServiceName

Gets or sets the name of the remote data service.

The default value is DataService

 

property DataServiceName: String read write;

 

String DataServiceName { get; set; }

 

Property DataServiceName() As String

DataStreamer

Specifies the DataStreamer to be used for decoding and encoding data that is received from or sent back to the server. Data Abstract uses Data Streamers to control how data is streamed between client and server applications. This allows the communication to use different data encodings based on your application's specific needs. These can be small and efficient binary encoding using the BinStreamer, cross-platform and easily parsable XML format with the upcoming XmlDataStreamer, or custom formats you can provide by implementing your own streamer class.

 

property DataStreamer: DataStreamer read write;

 

DataStreamer DataStreamer { get; set; }

 

Property DataStreamer() As DataStreamer

DataUpdateCall

Defines the remote service call that will be executed to Update the server data with local changes. By default, it will be mapped to the UpdateData call as defined in the IDataAbstractService implemented by standard Data Abstract 4.0 servers, but you can change its sub-properties to control how the data update call is made, if you are using a custom server interface.

 

property DataUpdateCall: DataUpdateRequest read;

 

DataUpdateRequest DataUpdateCall { get; }

 

ReadOnly Property DataUpdateCall() As DataUpdateRequest

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

 

method EndInternalUpdate(ar: IAsyncResult)

 

void EndInternalUpdate(IAsyncResult ar)

 

Sub EndInternalUpdate(ar As IAsyncResult)

Parameters:

  • ar:

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)    (declared in DataAdapter)

 

method Fill(dataset: DataSet)

 

void Fill(DataSet dataset)

 

Sub Fill(dataset As DataSet)

Parameters:

  • dataset:

Fill (DataSet, Boolean)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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>)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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>)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

method FillSchema(dataset: DataSet)

 

void FillSchema(DataSet dataset)

 

Sub FillSchema(dataset As DataSet)

Parameters:

  • dataset:

FillSchema (DataSet, Schema, array of String)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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>)    (declared in DataAdapter)

 

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    (declared in DataAdapter)

 

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()

GeneratedLoginString

This event is raised after the Data Adapter generates the login string while executing the Login method. This event allows to agust the generated login string.

 

event GeneratedLoginString: LoginStringEventHandler;
delegate: method GeneratedLoginString(sender: Object; e: LoginStringEventArgs)

 

delegate LoginStringEventHandler GeneratedLoginString()
delegate: void GeneratedLoginString(Object sender, LoginStringEventArgs e)

 

Event GeneratedLoginString As LoginStringEventHandler
delegate: Sub GeneratedLoginString(sender As Object, e As LoginStringEventArgs)

GeneratingLoginString

This event is raised when the Data Adapter generates the login string while executing the Login method. This event allows to provide a custom login string by stiing the correpronding EventArgs property, overriding the corresponding Data Adapter properties like LoginString, UserName and Password.

 

event GeneratingLoginString: LoginStringEventHandler;
delegate: method GeneratingLoginString(sender: Object; e: LoginStringEventArgs)

 

delegate LoginStringEventHandler GeneratingLoginString()
delegate: void GeneratingLoginString(Object sender, LoginStringEventArgs e)

 

Event GeneratingLoginString As LoginStringEventHandler
delegate: Sub GeneratingLoginString(sender As Object, e As LoginStringEventArgs)

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

 

property GetSchemaResultIsBinary: Boolean read;

 

Boolean GetSchemaResultIsBinary { get; }

 

ReadOnly Property GetSchemaResultIsBinary() As Boolean

HookupScriptEvents    (declared in DataAdapter)

 

method HookupScriptEvents(table: DataTable)

 

void HookupScriptEvents(DataTable table)

 

Sub HookupScriptEvents(table As DataTable)

Parameters:

  • table:

IsLoggedIn

Gets a flag indicating whether the last Login method call was successful.

 

property IsLoggedIn: Boolean read;

 

Boolean IsLoggedIn { get; }

 

ReadOnly Property IsLoggedIn() As Boolean

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()

Login

Performs user authentication based on the credentials provided by the corresponding Data Adapter properties like LoginString, UserName and Password. This method returns true if the user has been successully authenticated.

 

method Login: Boolean

 

Boolean Login()

 

Function Login() As Boolean

Login (String): Boolean

 

method Login(loginString: String): Boolean

 

Boolean Login(String loginString)

 

Function Login(loginString As String) As Boolean

Parameters:

  • loginString:

Login (String, String): Boolean

 

method Login(username: String; password: String): Boolean

 

Boolean Login(String username, String password)

 

Function Login(username As String, password As String) As Boolean

Parameters:

  • username:
  • password:

LoginServiceName

Gets or sets the name of the remote login service.

The default value is LoginService

 

property LoginServiceName: String read write;

 

String LoginServiceName { get; set; }

 

Property LoginServiceName() As String

LoginString

Gets or sets the semicolon-separated login string.

Setting this property automatically cleans the UserName and Password property values.

 

property LoginString: String read write;

 

String LoginString { get; set; }

 

Property LoginString() As String

Logout

Performs the user logout procedure.

 

method Logout

 

void Logout()

 

Sub Logout()

Password

Gets or sets the user passord used by the Login method.

Setting this property automatically cleans the LoginString property value.

 

property Password: String read write;

 

String Password { get; set; }

 

Property Password() As String

ReadSchema

 

method ReadSchema(forceRefresh: Boolean): Schema

 

Schema ReadSchema(Boolean forceRefresh)

 

Function ReadSchema(forceRefresh As Boolean) As Schema

Parameters:

  • forceRefresh:

ReadStreamerSchema  protected

 

method ReadStreamerSchema: Binary

 

Binary ReadStreamerSchema()

 

Function ReadStreamerSchema() As Binary

RemoteService

References the RemoteService component that defines the service to call for fetching and updating data and for retrieving schema information. By default, assigning a RemoteService component to this property will set the same service to be used for all three DataRequestCall, DataUpdateCall and SchemaCallrequests. However, you can override this by assigning a different RemoteService to the individual requests's RemoteService property.

 

property RemoteService: RemoteService read write;

 

RemoteService RemoteService { get; set; }

 

Property RemoteService() As RemoteService

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

SchemaCall

Defines the remote service call that will be executed to fetch Schema information from the remote server. By default, it will be mapped to the GetSchema call as defined in the IDataAbstractService implemented by standard Data Abstract 4.0 servers, but you can change its sub-properties to control how the schema request call is made, if you are using a custom server interface.

 

property SchemaCall: SchemaRequest read;

 

SchemaRequest SchemaCall { get; }

 

ReadOnly Property SchemaCall() As SchemaRequest

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    (declared in DataAdapter)

 

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 (DataSet, array of String, array of TableRequestInfo, array of WhereExpression, Boolean, IList<String>)  protected

 

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

 

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

 

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

Parameters:

  • dataset:
  • tableNames:
  • tableRequests:
  • whereClauses:
  • applySchema:
  • tablesThatNeedSchema:

SendFillRequest (DataTable, TableRequestInfo, WhereExpression, Boolean)  protected    (declared in DataAdapter)

 

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:

SendFillRequest (DataTable, TableRequestInfo, WhereExpression, Boolean)  protected

 

method SendFillRequest(table: DataTable; tableRequest: TableRequestInfo; whereClause: WhereExpression; applySchema: Boolean)

 

void SendFillRequest(DataTable table, TableRequestInfo tableRequest, WhereExpression whereClause, Boolean applySchema)

 

Sub SendFillRequest(table As DataTable, tableRequest As TableRequestInfo, whereClause As WhereExpression, applySchema As Boolean)

Parameters:

  • table:
  • tableRequest:
  • whereClause:
  • applySchema:

SetupDefaultRequests

 

method SetupDefaultRequests

 

void SetupDefaultRequests()

 

Sub SetupDefaultRequests()

ShowReconcileDialog    (declared in DataAdapter)

 

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    (declared in DataAdapter)

 

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

TargetUrl

Gets or sets the remote server Url.

Setting this property automatically cleans the RemoteService property value.

 

property TargetUrl: String read write;

 

String TargetUrl { get; set; }

 

Property TargetUrl() As String

TriggerAfterFillDataSet  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerAfterFillDataSet(e: RemoteDataAdapterFillDataSetEventArgs)

 

void TriggerAfterFillDataSet(RemoteDataAdapterFillDataSetEventArgs e)

 

Sub TriggerAfterFillDataSet(e As RemoteDataAdapterFillDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterFillDataTable  protected    (declared in DataAdapter)

 

method TriggerAfterFillDataTable(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerAfterFillDataTable(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerAfterFillDataTable(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e:

TriggerAfterFillDataTableSchema  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerAfterFillDataTableSchema(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerAfterFillDataTableSchema(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerAfterFillDataTableSchema(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterMergeDelta  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerAfterMergeDelta(e: RemoteDataAdapterDataTableDeltaEventArgs)

 

void TriggerAfterMergeDelta(RemoteDataAdapterDataTableDeltaEventArgs e)

 

Sub TriggerAfterMergeDelta(e As RemoteDataAdapterDataTableDeltaEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterUpdateDataSet  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerAfterUpdateDataSet(e: RemoteDataAdapterDataSetEventArgs)

 

void TriggerAfterUpdateDataSet(RemoteDataAdapterDataSetEventArgs e)

 

Sub TriggerAfterUpdateDataSet(e As RemoteDataAdapterDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerBeforeFillDataSet  protected    (declared in DataAdapter)

 

method TriggerBeforeFillDataSet(e: RemoteDataAdapterFillDataSetEventArgs)

 

void TriggerBeforeFillDataSet(RemoteDataAdapterFillDataSetEventArgs e)

 

Sub TriggerBeforeFillDataSet(e As RemoteDataAdapterFillDataSetEventArgs)

Parameters:

  • e:

TriggerBeforeFillDataTable  protected    (declared in DataAdapter)

 

method TriggerBeforeFillDataTable(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerBeforeFillDataTable(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerBeforeFillDataTable(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e:

TriggerBeforeMergeDelta  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerBeforeMergeDelta(e: RemoteDataAdapterDataTableDeltaEventArgs)

 

void TriggerBeforeMergeDelta(RemoteDataAdapterDataTableDeltaEventArgs e)

 

Sub TriggerBeforeMergeDelta(e As RemoteDataAdapterDataTableDeltaEventArgs)

Parameters:

  • e: Event arguments

TriggerBeforeUpdateDataSet  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerBeforeUpdateDataSet(e: RemoteDataAdapterDataSetEventArgs)

 

void TriggerBeforeUpdateDataSet(RemoteDataAdapterDataSetEventArgs e)

 

Sub TriggerBeforeUpdateDataSet(e As RemoteDataAdapterDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerGeneratedLoginString  protected

Raises the GeneratedLoginString event.

 

method TriggerGeneratedLoginString(e: LoginStringEventArgs)

 

void TriggerGeneratedLoginString(LoginStringEventArgs e)

 

Sub TriggerGeneratedLoginString(e As LoginStringEventArgs)

Parameters:

  • e: Event arguments

TriggerGeneratingLoginString  protected

Raises the GeneratingLoginString event.

 

method TriggerGeneratingLoginString(e: LoginStringEventArgs)

 

void TriggerGeneratingLoginString(LoginStringEventArgs e)

 

Sub TriggerGeneratingLoginString(e As LoginStringEventArgs)

Parameters:

  • e: Event arguments

TriggerUpdateFailure  protected    (declared in DataAdapter)

 

method TriggerUpdateFailure(e: RemoteDataAdapterUpdateFailureEventArgs)

 

void TriggerUpdateFailure(RemoteDataAdapterUpdateFailureEventArgs e)

 

Sub TriggerUpdateFailure(e As RemoteDataAdapterUpdateFailureEventArgs)

Parameters:

  • e:

UnHookScriptEvents    (declared in DataAdapter)

 

method UnHookScriptEvents(table: DataTable)

 

void UnHookScriptEvents(DataTable table)

 

Sub UnHookScriptEvents(table As DataTable)

Parameters:

  • table:

Update (DataSet)    (declared in DataAdapter)

 

method Update(dataset: DataSet)

 

void Update(DataSet dataset)

 

Sub Update(dataset As DataSet)

Parameters:

  • dataset:

Update (DataSet, array of String)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

method Update(deltas: array of Delta)

 

void Update(Delta[] deltas)

 

Sub Update(deltas As Delta())

Parameters:

  • deltas:

Update (array of Delta, Boolean)    (declared in DataAdapter)

 

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    (declared in DataAdapter)

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>

UserName

Gets or sets the user name used by the Login method.

Setting this property automatically cleans the LoginString property value.

 

property UserName: String read write;

 

String UserName { get; set; }

 

Property UserName() As String

 

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

DataRequestCall

Defines the remove service call that will be executed to Fill a dataset with data from the remote server. By default, it will be mapped to the GetData call as defined in the IDataAbstractService interface implemented by standard Data Abstract 4.0 servers, but you can change its sub-properties to control how the data request call is made, if you are using a custom server interface.

 

property DataRequestCall: DataRequestRequest read;

 

DataRequestRequest DataRequestCall { get; }

 

ReadOnly Property DataRequestCall() As DataRequestRequest

DataServiceName

Gets or sets the name of the remote data service.

The default value is DataService

 

property DataServiceName: String read write;

 

String DataServiceName { get; set; }

 

Property DataServiceName() As String

DataStreamer

Specifies the DataStreamer to be used for decoding and encoding data that is received from or sent back to the server. Data Abstract uses Data Streamers to control how data is streamed between client and server applications. This allows the communication to use different data encodings based on your application's specific needs. These can be small and efficient binary encoding using the BinStreamer, cross-platform and easily parsable XML format with the upcoming XmlDataStreamer, or custom formats you can provide by implementing your own streamer class.

 

property DataStreamer: DataStreamer read write;

 

DataStreamer DataStreamer { get; set; }

 

Property DataStreamer() As DataStreamer

DataUpdateCall

Defines the remote service call that will be executed to Update the server data with local changes. By default, it will be mapped to the UpdateData call as defined in the IDataAbstractService implemented by standard Data Abstract 4.0 servers, but you can change its sub-properties to control how the data update call is made, if you are using a custom server interface.

 

property DataUpdateCall: DataUpdateRequest read;

 

DataUpdateRequest DataUpdateCall { get; }

 

ReadOnly Property DataUpdateCall() As DataUpdateRequest

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

 

property GetSchemaResultIsBinary: Boolean read;

 

Boolean GetSchemaResultIsBinary { get; }

 

ReadOnly Property GetSchemaResultIsBinary() As Boolean

IsLoggedIn

Gets a flag indicating whether the last Login method call was successful.

 

property IsLoggedIn: Boolean read;

 

Boolean IsLoggedIn { get; }

 

ReadOnly Property IsLoggedIn() As Boolean

LoginServiceName

Gets or sets the name of the remote login service.

The default value is LoginService

 

property LoginServiceName: String read write;

 

String LoginServiceName { get; set; }

 

Property LoginServiceName() As String

LoginString

Gets or sets the semicolon-separated login string.

Setting this property automatically cleans the UserName and Password property values.

 

property LoginString: String read write;

 

String LoginString { get; set; }

 

Property LoginString() As String

Password

Gets or sets the user passord used by the Login method.

Setting this property automatically cleans the LoginString property value.

 

property Password: String read write;

 

String Password { get; set; }

 

Property Password() As String

RemoteService

References the RemoteService component that defines the service to call for fetching and updating data and for retrieving schema information. By default, assigning a RemoteService component to this property will set the same service to be used for all three DataRequestCall, DataUpdateCall and SchemaCallrequests. However, you can override this by assigning a different RemoteService to the individual requests's RemoteService property.

 

property RemoteService: RemoteService read write;

 

RemoteService RemoteService { get; set; }

 

Property RemoteService() As RemoteService

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

SchemaCall

Defines the remote service call that will be executed to fetch Schema information from the remote server. By default, it will be mapped to the GetSchema call as defined in the IDataAbstractService implemented by standard Data Abstract 4.0 servers, but you can change its sub-properties to control how the schema request call is made, if you are using a custom server interface.

 

property SchemaCall: SchemaRequest read;

 

SchemaRequest SchemaCall { get; }

 

ReadOnly Property SchemaCall() As SchemaRequest

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

TargetUrl

Gets or sets the remote server Url.

Setting this property automatically cleans the RemoteService property value.

 

property TargetUrl: String read write;

 

String TargetUrl { get; set; }

 

Property TargetUrl() As String

UserName

Gets or sets the user name used by the Login method.

Setting this property automatically cleans the LoginString property value.

 

property UserName: String read write;

 

String UserName { get; set; }

 

Property UserName() As String

 

constructor

 

constructor

 

RemoteDataAdapter()

 

Sub New()

constructor (Boolean)  protected    (declared in DataAdapter)

 

constructor(avoidLicenseCheck: Boolean)

 

RemoteDataAdapter(Boolean avoidLicenseCheck)

 

Sub New(avoidLicenseCheck As Boolean)

Parameters:

  • avoidLicenseCheck:

constructor (IContainer)

 

constructor(container: IContainer)

 

RemoteDataAdapter(IContainer container)

 

Sub New(container As IContainer)

Parameters:

  • container:

constructor (String)

 

constructor(targetUrl: String)

 

RemoteDataAdapter(String targetUrl)

 

Sub New(targetUrl As String)

Parameters:

  • targetUrl:

BeginInit    (declared in BaseDataAdapter)

 

method BeginInit

 

void BeginInit()

 

Sub BeginInit()

BeginInternalUpdate (array of Delta, AsyncCallback, Object): IAsyncResult  protected

 

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

 

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

 

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

Parameters:

  • deltas:
  • callback:
  • state:

BeginInternalUpdate (array of Delta, AsyncCallback, Object): IAsyncResult  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

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

 

method EndInternalUpdate(ar: IAsyncResult)

 

void EndInternalUpdate(IAsyncResult ar)

 

Sub EndInternalUpdate(ar As IAsyncResult)

Parameters:

  • ar:

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)    (declared in DataAdapter)

 

method Fill(dataset: DataSet)

 

void Fill(DataSet dataset)

 

Sub Fill(dataset As DataSet)

Parameters:

  • dataset:

Fill (DataSet, Boolean)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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>)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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>)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

method FillSchema(dataset: DataSet)

 

void FillSchema(DataSet dataset)

 

Sub FillSchema(dataset As DataSet)

Parameters:

  • dataset:

FillSchema (DataSet, Schema, array of String)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

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>)    (declared in DataAdapter)

 

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    (declared in DataAdapter)

 

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    (declared in DataAdapter)

 

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()

Login

Performs user authentication based on the credentials provided by the corresponding Data Adapter properties like LoginString, UserName and Password. This method returns true if the user has been successully authenticated.

 

method Login: Boolean

 

Boolean Login()

 

Function Login() As Boolean

Login (String): Boolean

 

method Login(loginString: String): Boolean

 

Boolean Login(String loginString)

 

Function Login(loginString As String) As Boolean

Parameters:

  • loginString:

Login (String, String): Boolean

 

method Login(username: String; password: String): Boolean

 

Boolean Login(String username, String password)

 

Function Login(username As String, password As String) As Boolean

Parameters:

  • username:
  • password:

Logout

Performs the user logout procedure.

 

method Logout

 

void Logout()

 

Sub Logout()

ReadSchema

 

method ReadSchema(forceRefresh: Boolean): Schema

 

Schema ReadSchema(Boolean forceRefresh)

 

Function ReadSchema(forceRefresh As Boolean) As Schema

Parameters:

  • forceRefresh:

ReadStreamerSchema  protected

 

method ReadStreamerSchema: Binary

 

Binary ReadStreamerSchema()

 

Function ReadStreamerSchema() As Binary

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

 

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 (DataSet, array of String, array of TableRequestInfo, array of WhereExpression, Boolean, IList<String>)  protected

 

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

 

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

 

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

Parameters:

  • dataset:
  • tableNames:
  • tableRequests:
  • whereClauses:
  • applySchema:
  • tablesThatNeedSchema:

SendFillRequest (DataTable, TableRequestInfo, WhereExpression, Boolean)  protected    (declared in DataAdapter)

 

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:

SendFillRequest (DataTable, TableRequestInfo, WhereExpression, Boolean)  protected

 

method SendFillRequest(table: DataTable; tableRequest: TableRequestInfo; whereClause: WhereExpression; applySchema: Boolean)

 

void SendFillRequest(DataTable table, TableRequestInfo tableRequest, WhereExpression whereClause, Boolean applySchema)

 

Sub SendFillRequest(table As DataTable, tableRequest As TableRequestInfo, whereClause As WhereExpression, applySchema As Boolean)

Parameters:

  • table:
  • tableRequest:
  • whereClause:
  • applySchema:

SetupDefaultRequests

 

method SetupDefaultRequests

 

void SetupDefaultRequests()

 

Sub SetupDefaultRequests()

TriggerAfterFillDataSet  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerAfterFillDataSet(e: RemoteDataAdapterFillDataSetEventArgs)

 

void TriggerAfterFillDataSet(RemoteDataAdapterFillDataSetEventArgs e)

 

Sub TriggerAfterFillDataSet(e As RemoteDataAdapterFillDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterFillDataTable  protected    (declared in DataAdapter)

 

method TriggerAfterFillDataTable(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerAfterFillDataTable(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerAfterFillDataTable(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e:

TriggerAfterFillDataTableSchema  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerAfterFillDataTableSchema(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerAfterFillDataTableSchema(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerAfterFillDataTableSchema(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterMergeDelta  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerAfterMergeDelta(e: RemoteDataAdapterDataTableDeltaEventArgs)

 

void TriggerAfterMergeDelta(RemoteDataAdapterDataTableDeltaEventArgs e)

 

Sub TriggerAfterMergeDelta(e As RemoteDataAdapterDataTableDeltaEventArgs)

Parameters:

  • e: Event arguments

TriggerAfterUpdateDataSet  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerAfterUpdateDataSet(e: RemoteDataAdapterDataSetEventArgs)

 

void TriggerAfterUpdateDataSet(RemoteDataAdapterDataSetEventArgs e)

 

Sub TriggerAfterUpdateDataSet(e As RemoteDataAdapterDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerBeforeFillDataSet  protected    (declared in DataAdapter)

 

method TriggerBeforeFillDataSet(e: RemoteDataAdapterFillDataSetEventArgs)

 

void TriggerBeforeFillDataSet(RemoteDataAdapterFillDataSetEventArgs e)

 

Sub TriggerBeforeFillDataSet(e As RemoteDataAdapterFillDataSetEventArgs)

Parameters:

  • e:

TriggerBeforeFillDataTable  protected    (declared in DataAdapter)

 

method TriggerBeforeFillDataTable(e: RemoteDataAdapterDataTableEventArgs)

 

void TriggerBeforeFillDataTable(RemoteDataAdapterDataTableEventArgs e)

 

Sub TriggerBeforeFillDataTable(e As RemoteDataAdapterDataTableEventArgs)

Parameters:

  • e:

TriggerBeforeMergeDelta  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerBeforeMergeDelta(e: RemoteDataAdapterDataTableDeltaEventArgs)

 

void TriggerBeforeMergeDelta(RemoteDataAdapterDataTableDeltaEventArgs e)

 

Sub TriggerBeforeMergeDelta(e As RemoteDataAdapterDataTableDeltaEventArgs)

Parameters:

  • e: Event arguments

TriggerBeforeUpdateDataSet  protected    (declared in DataAdapter)

Raises the DataAdapter event.

 

method TriggerBeforeUpdateDataSet(e: RemoteDataAdapterDataSetEventArgs)

 

void TriggerBeforeUpdateDataSet(RemoteDataAdapterDataSetEventArgs e)

 

Sub TriggerBeforeUpdateDataSet(e As RemoteDataAdapterDataSetEventArgs)

Parameters:

  • e: Event arguments

TriggerGeneratedLoginString  protected

Raises the GeneratedLoginString event.

 

method TriggerGeneratedLoginString(e: LoginStringEventArgs)

 

void TriggerGeneratedLoginString(LoginStringEventArgs e)

 

Sub TriggerGeneratedLoginString(e As LoginStringEventArgs)

Parameters:

  • e: Event arguments

TriggerGeneratingLoginString  protected

Raises the GeneratingLoginString event.

 

method TriggerGeneratingLoginString(e: LoginStringEventArgs)

 

void TriggerGeneratingLoginString(LoginStringEventArgs e)

 

Sub TriggerGeneratingLoginString(e As LoginStringEventArgs)

Parameters:

  • e: Event arguments

TriggerUpdateFailure  protected    (declared in DataAdapter)

 

method TriggerUpdateFailure(e: RemoteDataAdapterUpdateFailureEventArgs)

 

void TriggerUpdateFailure(RemoteDataAdapterUpdateFailureEventArgs e)

 

Sub TriggerUpdateFailure(e As RemoteDataAdapterUpdateFailureEventArgs)

Parameters:

  • e:

UnHookScriptEvents    (declared in DataAdapter)

 

method UnHookScriptEvents(table: DataTable)

 

void UnHookScriptEvents(DataTable table)

 

Sub UnHookScriptEvents(table As DataTable)

Parameters:

  • table:

Update (DataSet)    (declared in DataAdapter)

 

method Update(dataset: DataSet)

 

void Update(DataSet dataset)

 

Sub Update(dataset As DataSet)

Parameters:

  • dataset:

Update (DataSet, array of String)    (declared in DataAdapter)

 

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)    (declared in DataAdapter)

 

method Update(deltas: array of Delta)

 

void Update(Delta[] deltas)

 

Sub Update(deltas As Delta())

Parameters:

  • deltas:

Update (array of Delta, Boolean)    (declared in DataAdapter)

 

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    (declared in DataAdapter)

 

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    (declared in DataAdapter)

 

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    (declared in DataAdapter)

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    (declared in DataAdapter)

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    (declared in DataAdapter)

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    (declared in DataAdapter)

 

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    (declared in DataAdapter)

 

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    (declared in DataAdapter)

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    (declared in DataAdapter)

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)

GeneratedLoginString

This event is raised after the Data Adapter generates the login string while executing the Login method. This event allows to agust the generated login string.

 

event GeneratedLoginString: LoginStringEventHandler;
delegate: method GeneratedLoginString(sender: Object; e: LoginStringEventArgs)

 

delegate LoginStringEventHandler GeneratedLoginString()
delegate: void GeneratedLoginString(Object sender, LoginStringEventArgs e)

 

Event GeneratedLoginString As LoginStringEventHandler
delegate: Sub GeneratedLoginString(sender As Object, e As LoginStringEventArgs)

GeneratingLoginString

This event is raised when the Data Adapter generates the login string while executing the Login method. This event allows to provide a custom login string by stiing the correpronding EventArgs property, overriding the corresponding Data Adapter properties like LoginString, UserName and Password.

 

event GeneratingLoginString: LoginStringEventHandler;
delegate: method GeneratingLoginString(sender: Object; e: LoginStringEventArgs)

 

delegate LoginStringEventHandler GeneratingLoginString()
delegate: void GeneratingLoginString(Object sender, LoginStringEventArgs e)

 

Event GeneratingLoginString As LoginStringEventHandler
delegate: Sub GeneratingLoginString(sender As Object, e As LoginStringEventArgs)

ShowReconcileDialog    (declared in DataAdapter)

 

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    (declared in DataAdapter)

 

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    (declared in DataAdapter)

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>