LinqRemoteDataAdapter

Overview

The LinqRemoteDataAdapter class is a client-side component used inside all DA LINQ expressions as data provider.

You can select data with help of the LinqRemoteDataAdapter:

var query =
    from c in linqRemoteDataAdapter.GetTable<Client>()
    where (c.id > 3) and (c.phone.Contains("55"))   
    select new {
                 c.id, 
                 c.name, 
                 c.address, 
                 c.phone 
           };

var clients = q.ToList();

or collect changes and send them back to the server side for applying:

// Get list of employees
var q = from x in linqRemoteDataAdapter.GetTable<Worker>() 
        select x;
var list = q.ToList();

// Create new employee
var newEmployee = new Worker();
...
// Insert it
list.Add(newEmployee);

// Register change at the Data Adapter
linqRemoteDataAdapter.InsertRow(newEmployee);

// Edit an existing worker (at index 5 in the list)
list[5].WorkerCity = "Paris"; 
list[5].WorkerZip = "1234";

// Register change at the Data Adapter
linqRemoteDataAdapter.UpdateRow(list[5]);

// Remove an existing customer (at index 9 in the list)
list.RemoveAt(9);

// Register change at the Data Adapter
linqRemoteDataAdapter.DeleteRow(list[5]);

// Applying changes
linqRemoteDataAdapter.ApplyChanges();

You can fond more detailed information about how DA LINQ works in the article DA Linq in Depth (.NET) or in our DA LINQ Sample (.NET).

Location

 

constructor

Creates a new instance of the LinqRemoteDataAdapter class.

 

constructor

 

LinqRemoteDataAdapter()

 

Sub New

constructor (Boolean)  protected    (declared in LinqDataAdapter)

 

constructor(avoidLicenseCheck: Boolean)

 

LinqRemoteDataAdapter(Boolean avoidLicenseCheck)

 

Sub New (avoidLicenseCheck As Boolean)

Parameters:

  • avoidLicenseCheck:

constructor (String)

 

constructor(targetUrl: String)

 

LinqRemoteDataAdapter(String targetUrl)

 

Sub New (targetUrl As String)

Parameters:

  • targetUrl:

constructor (IContainer)

 

constructor(container: IContainer)

 

LinqRemoteDataAdapter(IContainer container)

 

Sub New (container As IContainer)

Parameters:

  • 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

add_GeneratedLoginString

 

method add_GeneratedLoginString(value: LoginStringEventHandler)

 

void add_GeneratedLoginString(LoginStringEventHandler value)

 

Sub add_GeneratedLoginString(value As LoginStringEventHandler)

Parameters:

  • value:

add_GeneratingLoginString

 

method add_GeneratingLoginString(value: LoginStringEventHandler)

 

void add_GeneratingLoginString(LoginStringEventHandler value)

 

Sub add_GeneratingLoginString(value As LoginStringEventHandler)

Parameters:

  • value:

add_OnApplyChanges    (declared in LinqDataAdapter)

 

method add_OnApplyChanges(value: EventHandler)

 

void add_OnApplyChanges(EventHandler value)

 

Sub add_OnApplyChanges(value As EventHandler)

Parameters:

  • value:

ApplyChanges    (declared in LinqDataAdapter)

Applies changes made to all RemoteTable instances retrieved via this LinqDataAdapter instance.

 

method ApplyChanges

 

void ApplyChanges()

 

Sub ApplyChanges

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

BeginApplyChanges    (declared in LinqDataAdapter)

Asyncronously applies changes made to all RemoteTable instances retrieved via this LinqDataAdapter instance.

 

method BeginApplyChanges(cb: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginApplyChanges(AsyncCallback cb, Object state)

 

Function BeginApplyChanges(cb As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • cb: Callback method that will be called once the update process is done.
  • state: State information about the asynchronous operation.

BeginExecute    (declared in LinqDataAdapter)

Asynchronously executes the provided queries. Basically, this is the only way to execute a DA Linq query in a Silverlight application.

This code sample demonstrates how data is retrieved in a Silverlight application (code snippet from the Silverlight sample shipped with DataAbstract for .NET):

var q = (from x in linqRemoteDataAdapter.GetTable<Products>() select x);
IQueryable[] Queries = new IQueryable[] { q };
linqRemoteDataAdapter.BeginExecute(
    Queries,
    delegate(IAsyncResult ar)
    {
        linqRemoteDataAdapter.EndExecute(ar);
        Dispatcher.BeginInvoke(new ProcessSelectProductsResultCb(ProcessSelectProductsResult), q.ToList<Products>());
    },
    null);

 

method BeginExecute(query: array of IQueryable; callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginExecute(IQueryable[] query, AsyncCallback callback, Object state)

 

Function BeginExecute(query As array of IQueryable, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • query: Array of IQueryable objects representing DA Linq queries.
  • callback:
  • state: State information about the asynchronous operation.

BeginFetchData

 

method BeginFetchData(tableRequest: array of TableRequestInfo; tableNames: array of String; fillMethod: Action<Int32, array of Int32, IDataReader>; callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginFetchData(TableRequestInfo[] tableRequest, String[] tableNames, Action<Int32, Int32[], IDataReader> fillMethod, AsyncCallback callback, Object state)

 

Function BeginFetchData(tableRequest As array of TableRequestInfo, tableNames As array of String, fillMethod As Action<Int32, array of Int32, IDataReader>, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • tableRequest:
  • tableNames:
  • fillMethod:
  • callback:
  • state:

BeginInit    (declared in BaseDataAdapter)

 

method BeginInit

 

void BeginInit()

 

Sub BeginInit

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 array of 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

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 array of Delta, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • deltas:
  • callback:
  • state:

BeginLogin (AsyncCallback, Object): IAsyncResult

Starts the asynchronous user login procedure.

 

method BeginLogin(callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginLogin(AsyncCallback callback, Object state)

 

Function BeginLogin(callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • callback: Callback method that will be called once the login process is done.
  • state: State information about the asynchronous operation

BeginLogin (String, AsyncCallback, Object): IAsyncResult

 

method BeginLogin(loginString: String; callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginLogin(String loginString, AsyncCallback callback, Object state)

 

Function BeginLogin(loginString As String, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • loginString:
  • callback:
  • state:

BeginLogin (String, String, AsyncCallback, Object): IAsyncResult

 

method BeginLogin(username: String; password: String; callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginLogin(String username, String password, AsyncCallback callback, Object state)

 

Function BeginLogin(username As String, password As String, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • username:
  • password:
  • callback:
  • state:

BeginLogout

Starts the asynchronous user logout procedure.

 

method BeginLogout(callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginLogout(AsyncCallback callback, Object state)

 

Function BeginLogout(callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • callback: Callback method that will be called once the logout process is done.
  • state: State information about the asynchronous operation

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

CancelChanges    (declared in LinqDataAdapter)

Clears changes made to all RemoteTable instances retrieved via this LinqDataAdapter instance.

 

method CancelChanges

 

void CancelChanges()

 

Sub CancelChanges

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

ClearAsyncResults    (declared in LinqDataAdapter)

 

method ClearAsyncResults

 

void ClearAsyncResults()

 

Sub ClearAsyncResults

CloneTable<T>    (declared in LinqDataAdapter)

 

method CloneTable<T>(source: T): T

 

T CloneTable<T>(T source)

 

Function CloneTable<T>(source As T) As T

Parameters:

  • source:

CompareBytes    (declared in LinqDataAdapter)

 

class method CompareBytes(a: array of Byte; b: array of Byte): Boolean

 

static Boolean CompareBytes(Byte[] a, Byte[] b)

 

Shared Function CompareBytes(a As array of Byte, b As array of Byte) As Boolean

Parameters:

  • a:
  • b:

DataRequestCall

Defines the remote service call that will be executed to fill the dataset with data from the remote server. This property is read-only.

 

property DataRequestCall: DataRequestRequest read;

 

DataRequestRequest DataRequestCall { get; }

 

Property ReadOnly 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

Represents the DataStreamer object that is associated with the current LinqRemoteDataAdapter object. It is used for decoding and encoding data that is received from or sent back to the server.

 

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. This property is read-only.

 

property DataUpdateCall: DataUpdateRequest read;

 

DataUpdateRequest DataUpdateCall { get; }

 

Property ReadOnly DataUpdateCall As DataUpdateRequest

DeleteRow<T>    (declared in LinqDataAdapter)

 

method DeleteRow<T>(data: T): DeltaChange

 

DeltaChange DeleteRow<T>(T data)

 

Function DeleteRow<T>(data As T) As DeltaChange

Parameters:

  • data:

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

EndApplyChanges    (declared in LinqDataAdapter)

Ends an asynchronous remote database update.

 

method EndApplyChanges(ar: IAsyncResult)

 

void EndApplyChanges(IAsyncResult ar)

 

Sub EndApplyChanges(ar As IAsyncResult)

Parameters:

  • ar: The pending asynchronous data update operation.

EndExecute    (declared in LinqDataAdapter)

Ends an asynchronous query request to a data service.

 

method EndExecute(ar: IAsyncResult)

 

void EndExecute(IAsyncResult ar)

 

Sub EndExecute(ar As IAsyncResult)

Parameters:

  • ar: The pending asynchronous query request.

EndFetchData

 

method EndFetchData(ar: IAsyncResult)

 

void EndFetchData(IAsyncResult ar)

 

Sub EndFetchData(ar As IAsyncResult)

Parameters:

  • ar:

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:

EndLogin

Completes the asynchronous user login procedure.

 

method EndLogin(ar: IAsyncResult): Boolean

 

Boolean EndLogin(IAsyncResult ar)

 

Function EndLogin(ar As IAsyncResult) As Boolean

Parameters:

  • ar: The pending asynchronous user login operation

EndLogout

Completes the asynchronous user logout procedure.

 

method EndLogout(ar: IAsyncResult)

 

void EndLogout(IAsyncResult ar)

 

Sub EndLogout(ar As IAsyncResult)

Parameters:

  • ar: The pending asynchronous user logout operation

EnterCriticalSection  protected    (declared in BaseDataAdapter)

 

method EnterCriticalSection(status: DataAdapterStatus)

 

void EnterCriticalSection(DataAdapterStatus status)

 

Sub EnterCriticalSection(status As DataAdapterStatus)

Parameters:

  • status:

Execute    (declared in LinqDataAdapter)

 

method Execute(query: array of IQueryable): array of Object

 

Object[] Execute(IQueryable[] query)

 

Function Execute(query As array of IQueryable) As array of Object

Parameters:

  • query:

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

FetchData

 

method FetchData(tableRequest: array of TableRequestInfo; tableNames: array of String; fillMethod: Action<Int32, array of Int32, IDataReader>)

 

void FetchData(TableRequestInfo[] tableRequest, String[] tableNames, Action<Int32, Int32[], IDataReader> fillMethod)

 

Sub FetchData(tableRequest As array of TableRequestInfo, tableNames As array of String, fillMethod As Action<Int32, array of Int32, IDataReader>)

Parameters:

  • tableRequest:
  • tableNames:
  • fillMethod:

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)

GetPendingDeltas  protected    (declared in LinqDataAdapter)

 

method GetPendingDeltas: array of Delta

 

Delta[] GetPendingDeltas()

 

Function GetPendingDeltas As array of Delta

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

GetTable<T>    (declared in LinqDataAdapter)

 

method GetTable<T>: RemoteTable<T>

 

RemoteTable<T> GetTable<T>()

 

Function GetTable<T> As RemoteTable<T>

GetTable<T> (array of DataParameter): RemoteTableQuery<T>    (declared in LinqDataAdapter)

 

method GetTable<T>(params parameters: array of DataParameter): RemoteTableQuery<T>

 

RemoteTableQuery<T> GetTable<T>(params DataParameter[] parameters)

 

Function GetTable<T>(ParamArray parameters As array of DataParameter) As RemoteTableQuery<T>

Parameters:

  • parameters:

InitScriptProvider    (declared in LinqDataAdapter)

 

method InitScriptProvider: Boolean

 

Boolean InitScriptProvider()

 

Function InitScriptProvider As Boolean

InsertRow<T>    (declared in LinqDataAdapter)

 

method InsertRow<T>(data: T): DeltaChange

 

DeltaChange InsertRow<T>(T data)

 

Function InsertRow<T>(data As T) As DeltaChange

Parameters:

  • data:

IsLoggedIn

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

 

property IsLoggedIn: Boolean read;

 

Boolean IsLoggedIn { get; }

 

Property ReadOnly 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

NewRow<T>    (declared in LinqDataAdapter)

 

method NewRow<T>: T

 

T NewRow<T>()

 

Function NewRow<T> As T

OnApplyChanges    (declared in LinqDataAdapter)

This event is fired before any data changes are sent to the DataAbstract server. It can be used to perform data validation, changes logging, etc.

 

event OnApplyChanges: EventHandler;

 

delegate EventHandler OnApplyChanges()

 

Event OnApplyChanges As EventHandler

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

ProcessPendingChangeDeltas  protected    (declared in LinqDataAdapter)

 

method ProcessPendingChangeDeltas(serverDeltas: array of Delta; originalDeltaChangeIds: IDictionary<String, array of Int32>)

 

void ProcessPendingChangeDeltas(Delta[] serverDeltas, IDictionary<String, Int32[]> originalDeltaChangeIds)

 

Sub ProcessPendingChangeDeltas(serverDeltas As array of Delta, originalDeltaChangeIds As IDictionary<String, array of Int32>)

Parameters:

  • serverDeltas:
  • originalDeltaChangeIds:

ReadSchema

Reads the Schema if the ReadSchema method is called first or aForceReRead is true. Returns the newly created Schema object or an existing Schema object.

 

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

Returns Schema information in Binary format.

 

method ReadStreamerSchema: Binary

 

Binary ReadStreamerSchema()

 

Function ReadStreamerSchema As Binary

RemoteService

Specifies the RemoteService object that is used to call for fetching and updating data and for retrieving schema information.

 

property RemoteService: RemoteService read write;

 

RemoteService RemoteService { get; set; }

 

Property RemoteService As RemoteService

remove_GeneratedLoginString

 

method remove_GeneratedLoginString(value: LoginStringEventHandler)

 

void remove_GeneratedLoginString(LoginStringEventHandler value)

 

Sub remove_GeneratedLoginString(value As LoginStringEventHandler)

Parameters:

  • value:

remove_GeneratingLoginString

 

method remove_GeneratingLoginString(value: LoginStringEventHandler)

 

void remove_GeneratingLoginString(LoginStringEventHandler value)

 

Sub remove_GeneratingLoginString(value As LoginStringEventHandler)

Parameters:

  • value:

remove_OnApplyChanges    (declared in LinqDataAdapter)

 

method remove_OnApplyChanges(value: EventHandler)

 

void remove_OnApplyChanges(EventHandler value)

 

Sub remove_OnApplyChanges(value As EventHandler)

Parameters:

  • value:

RemoveAsyncResult    (declared in LinqDataAdapter)

 

method RemoveAsyncResult(query: IQueryable)

 

void RemoveAsyncResult(IQueryable query)

 

Sub RemoveAsyncResult(query As IQueryable)

Parameters:

  • query:

Schema    (declared in BaseDataAdapter)

Gets the Schema currently cached by the Data Adapter instance

 

property Schema: Schema read;

 

Schema Schema { get; }

 

Property ReadOnly Schema As Schema

SchemaCall

Defines the remote service call that will be executed to fetch Schema information from the remote server.

 

property SchemaCall: SchemaRequest read;

 

SchemaRequest SchemaCall { get; }

 

Property ReadOnly 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

SetupDefaultRequests

Sets or resets all parameters to the default settings for the SchemaCall, DataRequestCall and DataUpdateCall properties. This is necessary when accessing a standard Data Abstract server implementing the IDataAbstractService.

 

method SetupDefaultRequests

 

void SetupDefaultRequests()

 

Sub SetupDefaultRequests

Status    (declared in BaseDataAdapter)

Gets current status of the Data Adapter

 

property Status: DataAdapterStatus read;

 

DataAdapterStatus Status { get; }

 

Property ReadOnly 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

ThrowFailures  protected    (declared in LinqDataAdapter)

This method is called at the end of the ApplyChanges method. It throws a DAUpdatesFailedException if the provided aChanges list is not empty (which means that some DeltaChanges were not processed successfully) and the FailureBehavior property is set to FailureBehavior.RaiseException or FailureBehavior.Both.

 

method ThrowFailures(changes: List<DeltaChange>; failureMessage: String)

 

void ThrowFailures(List<DeltaChange> changes, String failureMessage)

 

Sub ThrowFailures(changes As List<DeltaChange>, failureMessage As String)

Parameters:

  • changes:
  • failureMessage:

TriggerApplyChanges  protected    (declared in LinqDataAdapter)

 

method TriggerApplyChanges

 

void TriggerApplyChanges()

 

Sub TriggerApplyChanges

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

UpdateRow<T> (T): DeltaChange    (declared in LinqDataAdapter)

 

method UpdateRow<T>(data: T): DeltaChange

 

DeltaChange UpdateRow<T>(T data)

 

Function UpdateRow<T>(data As T) As DeltaChange

Parameters:

  • data:

UpdateRow<T> (T, T): DeltaChange    (declared in LinqDataAdapter)

 

method UpdateRow<T>(originalData: T; newData: T): DeltaChange

 

DeltaChange UpdateRow<T>(T originalData, T newData)

 

Function UpdateRow<T>(originalData As T, newData As T) As DeltaChange

Parameters:

  • originalData:
  • newData:

UseBindableClass    (declared in LinqDataAdapter)

Defines which type will be used as the base type for query result representation: the ordinary System.Collections.Generic.List class (which will be used if this property is set to false) or the more advanced DABindingList class.

The default value of this property is true.

Yuo can set this property to false if you just want to retrieve data, but do not need the advanced binding capabilities of the DABindingList class.

 

property UseBindableClass: Boolean read write;

 

Boolean UseBindableClass { get; set; }

 

Property UseBindableClass As Boolean

UseDynamicWhere    (declared in LinqDataAdapter)

Defines how the data will be retrieved from the DataAbstract server. If this property is set to true, Dynamic Where will be used. If set to false, the more advanced DA SQL approach will be used (note that this approach is not compatible with Delphi-based DataAbstract servers).

The default value of this property is true for assemblies for the full .NET and the .NET Compact Frameworks, false for the Silverlight version of DataAbstract for .NET.

Note: If your client application is intended to be used only with .NET-based Data Abstract servers, the recommended value of this property is false, because some Linq operators cannot be represented with Dynamic Where conditions.

 

property UseDynamicWhere: Boolean read write;

 

Boolean UseDynamicWhere { get; set; }

 

Property UseDynamicWhere As Boolean

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 remote service call that will be executed to fill the dataset with data from the remote server. This property is read-only.

 

property DataRequestCall: DataRequestRequest read;

 

DataRequestRequest DataRequestCall { get; }

 

Property ReadOnly 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

Represents the DataStreamer object that is associated with the current LinqRemoteDataAdapter object. It is used for decoding and encoding data that is received from or sent back to the server.

 

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. This property is read-only.

 

property DataUpdateCall: DataUpdateRequest read;

 

DataUpdateRequest DataUpdateCall { get; }

 

Property ReadOnly 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

IsLoggedIn

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

 

property IsLoggedIn: Boolean read;

 

Boolean IsLoggedIn { get; }

 

Property ReadOnly 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

Specifies the RemoteService object that is used to call for fetching and updating data and for retrieving schema information.

 

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; }

 

Property ReadOnly Schema As Schema

SchemaCall

Defines the remote service call that will be executed to fetch Schema information from the remote server.

 

property SchemaCall: SchemaRequest read;

 

SchemaRequest SchemaCall { get; }

 

Property ReadOnly 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; }

 

Property ReadOnly 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

UseBindableClass    (declared in LinqDataAdapter)

Defines which type will be used as the base type for query result representation: the ordinary System.Collections.Generic.List class (which will be used if this property is set to false) or the more advanced DABindingList class.

The default value of this property is true.

Yuo can set this property to false if you just want to retrieve data, but do not need the advanced binding capabilities of the DABindingList class.

 

property UseBindableClass: Boolean read write;

 

Boolean UseBindableClass { get; set; }

 

Property UseBindableClass As Boolean

UseDynamicWhere    (declared in LinqDataAdapter)

Defines how the data will be retrieved from the DataAbstract server. If this property is set to true, Dynamic Where will be used. If set to false, the more advanced DA SQL approach will be used (note that this approach is not compatible with Delphi-based DataAbstract servers).

The default value of this property is true for assemblies for the full .NET and the .NET Compact Frameworks, false for the Silverlight version of DataAbstract for .NET.

Note: If your client application is intended to be used only with .NET-based Data Abstract servers, the recommended value of this property is false, because some Linq operators cannot be represented with Dynamic Where conditions.

 

property UseDynamicWhere: Boolean read write;

 

Boolean UseDynamicWhere { get; set; }

 

Property UseDynamicWhere As Boolean

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

 

CompareBytes    (declared in LinqDataAdapter)

 

class method CompareBytes(a: array of Byte; b: array of Byte): Boolean

 

static Boolean CompareBytes(Byte[] a, Byte[] b)

 

Shared Function CompareBytes(a As array of Byte, b As array of Byte) As Boolean

Parameters:

  • a:
  • b:

 

constructor

Creates a new instance of the LinqRemoteDataAdapter class.

 

constructor

 

LinqRemoteDataAdapter()

 

Sub New

constructor (Boolean)  protected    (declared in LinqDataAdapter)

 

constructor(avoidLicenseCheck: Boolean)

 

LinqRemoteDataAdapter(Boolean avoidLicenseCheck)

 

Sub New (avoidLicenseCheck As Boolean)

Parameters:

  • avoidLicenseCheck:

constructor (String)

 

constructor(targetUrl: String)

 

LinqRemoteDataAdapter(String targetUrl)

 

Sub New (targetUrl As String)

Parameters:

  • targetUrl:

constructor (IContainer)

 

constructor(container: IContainer)

 

LinqRemoteDataAdapter(IContainer container)

 

Sub New (container As IContainer)

Parameters:

  • container:

add_GeneratedLoginString

 

method add_GeneratedLoginString(value: LoginStringEventHandler)

 

void add_GeneratedLoginString(LoginStringEventHandler value)

 

Sub add_GeneratedLoginString(value As LoginStringEventHandler)

Parameters:

  • value:

add_GeneratingLoginString

 

method add_GeneratingLoginString(value: LoginStringEventHandler)

 

void add_GeneratingLoginString(LoginStringEventHandler value)

 

Sub add_GeneratingLoginString(value As LoginStringEventHandler)

Parameters:

  • value:

add_OnApplyChanges    (declared in LinqDataAdapter)

 

method add_OnApplyChanges(value: EventHandler)

 

void add_OnApplyChanges(EventHandler value)

 

Sub add_OnApplyChanges(value As EventHandler)

Parameters:

  • value:

ApplyChanges    (declared in LinqDataAdapter)

Applies changes made to all RemoteTable instances retrieved via this LinqDataAdapter instance.

 

method ApplyChanges

 

void ApplyChanges()

 

Sub ApplyChanges

BeginApplyChanges    (declared in LinqDataAdapter)

Asyncronously applies changes made to all RemoteTable instances retrieved via this LinqDataAdapter instance.

 

method BeginApplyChanges(cb: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginApplyChanges(AsyncCallback cb, Object state)

 

Function BeginApplyChanges(cb As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • cb: Callback method that will be called once the update process is done.
  • state: State information about the asynchronous operation.

BeginExecute    (declared in LinqDataAdapter)

Asynchronously executes the provided queries. Basically, this is the only way to execute a DA Linq query in a Silverlight application.

This code sample demonstrates how data is retrieved in a Silverlight application (code snippet from the Silverlight sample shipped with DataAbstract for .NET):

var q = (from x in linqRemoteDataAdapter.GetTable<Products>() select x);
IQueryable[] Queries = new IQueryable[] { q };
linqRemoteDataAdapter.BeginExecute(
    Queries,
    delegate(IAsyncResult ar)
    {
        linqRemoteDataAdapter.EndExecute(ar);
        Dispatcher.BeginInvoke(new ProcessSelectProductsResultCb(ProcessSelectProductsResult), q.ToList<Products>());
    },
    null);

 

method BeginExecute(query: array of IQueryable; callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginExecute(IQueryable[] query, AsyncCallback callback, Object state)

 

Function BeginExecute(query As array of IQueryable, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • query: Array of IQueryable objects representing DA Linq queries.
  • callback:
  • state: State information about the asynchronous operation.

BeginFetchData

 

method BeginFetchData(tableRequest: array of TableRequestInfo; tableNames: array of String; fillMethod: Action<Int32, array of Int32, IDataReader>; callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginFetchData(TableRequestInfo[] tableRequest, String[] tableNames, Action<Int32, Int32[], IDataReader> fillMethod, AsyncCallback callback, Object state)

 

Function BeginFetchData(tableRequest As array of TableRequestInfo, tableNames As array of String, fillMethod As Action<Int32, array of Int32, IDataReader>, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • tableRequest:
  • tableNames:
  • fillMethod:
  • callback:
  • state:

BeginInit    (declared in BaseDataAdapter)

 

method BeginInit

 

void BeginInit()

 

Sub BeginInit

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 array of 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

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 array of Delta, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • deltas:
  • callback:
  • state:

BeginLogin (AsyncCallback, Object): IAsyncResult

Starts the asynchronous user login procedure.

 

method BeginLogin(callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginLogin(AsyncCallback callback, Object state)

 

Function BeginLogin(callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • callback: Callback method that will be called once the login process is done.
  • state: State information about the asynchronous operation

BeginLogin (String, AsyncCallback, Object): IAsyncResult

 

method BeginLogin(loginString: String; callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginLogin(String loginString, AsyncCallback callback, Object state)

 

Function BeginLogin(loginString As String, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • loginString:
  • callback:
  • state:

BeginLogin (String, String, AsyncCallback, Object): IAsyncResult

 

method BeginLogin(username: String; password: String; callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginLogin(String username, String password, AsyncCallback callback, Object state)

 

Function BeginLogin(username As String, password As String, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • username:
  • password:
  • callback:
  • state:

BeginLogout

Starts the asynchronous user logout procedure.

 

method BeginLogout(callback: AsyncCallback; state: Object): IAsyncResult

 

IAsyncResult BeginLogout(AsyncCallback callback, Object state)

 

Function BeginLogout(callback As AsyncCallback, state As Object) As IAsyncResult

Parameters:

  • callback: Callback method that will be called once the logout process is done.
  • state: State information about the asynchronous operation

CancelChanges    (declared in LinqDataAdapter)

Clears changes made to all RemoteTable instances retrieved via this LinqDataAdapter instance.

 

method CancelChanges

 

void CancelChanges()

 

Sub CancelChanges

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

ClearAsyncResults    (declared in LinqDataAdapter)

 

method ClearAsyncResults

 

void ClearAsyncResults()

 

Sub ClearAsyncResults

CloneTable<T>    (declared in LinqDataAdapter)

 

method CloneTable<T>(source: T): T

 

T CloneTable<T>(T source)

 

Function CloneTable<T>(source As T) As T

Parameters:

  • source:

DeleteRow<T>    (declared in LinqDataAdapter)

 

method DeleteRow<T>(data: T): DeltaChange

 

DeltaChange DeleteRow<T>(T data)

 

Function DeleteRow<T>(data As T) As DeltaChange

Parameters:

  • data:

EndApplyChanges    (declared in LinqDataAdapter)

Ends an asynchronous remote database update.

 

method EndApplyChanges(ar: IAsyncResult)

 

void EndApplyChanges(IAsyncResult ar)

 

Sub EndApplyChanges(ar As IAsyncResult)

Parameters:

  • ar: The pending asynchronous data update operation.

EndExecute    (declared in LinqDataAdapter)

Ends an asynchronous query request to a data service.

 

method EndExecute(ar: IAsyncResult)

 

void EndExecute(IAsyncResult ar)

 

Sub EndExecute(ar As IAsyncResult)

Parameters:

  • ar: The pending asynchronous query request.

EndFetchData

 

method EndFetchData(ar: IAsyncResult)

 

void EndFetchData(IAsyncResult ar)

 

Sub EndFetchData(ar As IAsyncResult)

Parameters:

  • ar:

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:

EndLogin

Completes the asynchronous user login procedure.

 

method EndLogin(ar: IAsyncResult): Boolean

 

Boolean EndLogin(IAsyncResult ar)

 

Function EndLogin(ar As IAsyncResult) As Boolean

Parameters:

  • ar: The pending asynchronous user login operation

EndLogout

Completes the asynchronous user logout procedure.

 

method EndLogout(ar: IAsyncResult)

 

void EndLogout(IAsyncResult ar)

 

Sub EndLogout(ar As IAsyncResult)

Parameters:

  • ar: The pending asynchronous user logout operation

EnterCriticalSection  protected    (declared in BaseDataAdapter)

 

method EnterCriticalSection(status: DataAdapterStatus)

 

void EnterCriticalSection(DataAdapterStatus status)

 

Sub EnterCriticalSection(status As DataAdapterStatus)

Parameters:

  • status:

Execute    (declared in LinqDataAdapter)

 

method Execute(query: array of IQueryable): array of Object

 

Object[] Execute(IQueryable[] query)

 

Function Execute(query As array of IQueryable) As array of Object

Parameters:

  • query:

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

FetchData

 

method FetchData(tableRequest: array of TableRequestInfo; tableNames: array of String; fillMethod: Action<Int32, array of Int32, IDataReader>)

 

void FetchData(TableRequestInfo[] tableRequest, String[] tableNames, Action<Int32, Int32[], IDataReader> fillMethod)

 

Sub FetchData(tableRequest As array of TableRequestInfo, tableNames As array of String, fillMethod As Action<Int32, array of Int32, IDataReader>)

Parameters:

  • tableRequest:
  • tableNames:
  • fillMethod:

FlushSchema    (declared in BaseDataAdapter)

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

 

method FlushSchema

 

void FlushSchema()

 

Sub FlushSchema

GetPendingDeltas  protected    (declared in LinqDataAdapter)

 

method GetPendingDeltas: array of Delta

 

Delta[] GetPendingDeltas()

 

Function GetPendingDeltas As array of Delta

GetTable<T>    (declared in LinqDataAdapter)

 

method GetTable<T>: RemoteTable<T>

 

RemoteTable<T> GetTable<T>()

 

Function GetTable<T> As RemoteTable<T>

GetTable<T> (array of DataParameter): RemoteTableQuery<T>    (declared in LinqDataAdapter)

 

method GetTable<T>(params parameters: array of DataParameter): RemoteTableQuery<T>

 

RemoteTableQuery<T> GetTable<T>(params DataParameter[] parameters)

 

Function GetTable<T>(ParamArray parameters As array of DataParameter) As RemoteTableQuery<T>

Parameters:

  • parameters:

InitScriptProvider    (declared in LinqDataAdapter)

 

method InitScriptProvider: Boolean

 

Boolean InitScriptProvider()

 

Function InitScriptProvider As Boolean

InsertRow<T>    (declared in LinqDataAdapter)

 

method InsertRow<T>(data: T): DeltaChange

 

DeltaChange InsertRow<T>(T data)

 

Function InsertRow<T>(data As T) As DeltaChange

Parameters:

  • data:

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

NewRow<T>    (declared in LinqDataAdapter)

 

method NewRow<T>: T

 

T NewRow<T>()

 

Function NewRow<T> As T

ProcessPendingChangeDeltas  protected    (declared in LinqDataAdapter)

 

method ProcessPendingChangeDeltas(serverDeltas: array of Delta; originalDeltaChangeIds: IDictionary<String, array of Int32>)

 

void ProcessPendingChangeDeltas(Delta[] serverDeltas, IDictionary<String, Int32[]> originalDeltaChangeIds)

 

Sub ProcessPendingChangeDeltas(serverDeltas As array of Delta, originalDeltaChangeIds As IDictionary<String, array of Int32>)

Parameters:

  • serverDeltas:
  • originalDeltaChangeIds:

ReadSchema

Reads the Schema if the ReadSchema method is called first or aForceReRead is true. Returns the newly created Schema object or an existing Schema object.

 

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

Returns Schema information in Binary format.

 

method ReadStreamerSchema: Binary

 

Binary ReadStreamerSchema()

 

Function ReadStreamerSchema As Binary

remove_GeneratedLoginString

 

method remove_GeneratedLoginString(value: LoginStringEventHandler)

 

void remove_GeneratedLoginString(LoginStringEventHandler value)

 

Sub remove_GeneratedLoginString(value As LoginStringEventHandler)

Parameters:

  • value:

remove_GeneratingLoginString

 

method remove_GeneratingLoginString(value: LoginStringEventHandler)

 

void remove_GeneratingLoginString(LoginStringEventHandler value)

 

Sub remove_GeneratingLoginString(value As LoginStringEventHandler)

Parameters:

  • value:

remove_OnApplyChanges    (declared in LinqDataAdapter)

 

method remove_OnApplyChanges(value: EventHandler)

 

void remove_OnApplyChanges(EventHandler value)

 

Sub remove_OnApplyChanges(value As EventHandler)

Parameters:

  • value:

RemoveAsyncResult    (declared in LinqDataAdapter)

 

method RemoveAsyncResult(query: IQueryable)

 

void RemoveAsyncResult(IQueryable query)

 

Sub RemoveAsyncResult(query As IQueryable)

Parameters:

  • query:

SetupDefaultRequests

Sets or resets all parameters to the default settings for the SchemaCall, DataRequestCall and DataUpdateCall properties. This is necessary when accessing a standard Data Abstract server implementing the IDataAbstractService.

 

method SetupDefaultRequests

 

void SetupDefaultRequests()

 

Sub SetupDefaultRequests

ThrowFailures  protected    (declared in LinqDataAdapter)

This method is called at the end of the ApplyChanges method. It throws a DAUpdatesFailedException if the provided aChanges list is not empty (which means that some DeltaChanges were not processed successfully) and the FailureBehavior property is set to FailureBehavior.RaiseException or FailureBehavior.Both.

 

method ThrowFailures(changes: List<DeltaChange>; failureMessage: String)

 

void ThrowFailures(List<DeltaChange> changes, String failureMessage)

 

Sub ThrowFailures(changes As List<DeltaChange>, failureMessage As String)

Parameters:

  • changes:
  • failureMessage:

TriggerApplyChanges  protected    (declared in LinqDataAdapter)

 

method TriggerApplyChanges

 

void TriggerApplyChanges()

 

Sub TriggerApplyChanges

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

UpdateRow<T> (T): DeltaChange    (declared in LinqDataAdapter)

 

method UpdateRow<T>(data: T): DeltaChange

 

DeltaChange UpdateRow<T>(T data)

 

Function UpdateRow<T>(data As T) As DeltaChange

Parameters:

  • data:

UpdateRow<T> (T, T): DeltaChange    (declared in LinqDataAdapter)

 

method UpdateRow<T>(originalData: T; newData: T): DeltaChange

 

DeltaChange UpdateRow<T>(T originalData, T newData)

 

Function UpdateRow<T>(originalData As T, newData As T) As DeltaChange

Parameters:

  • originalData:
  • newData:

 

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)

OnApplyChanges    (declared in LinqDataAdapter)

This event is fired before any data changes are sent to the DataAbstract server. It can be used to perform data validation, changes logging, etc.

 

event OnApplyChanges: EventHandler;

 

delegate EventHandler OnApplyChanges()

 

Event OnApplyChanges As EventHandler

See Also

  • DA LINQ
  • DA LINQ in Depth (.NET)
  • DA LINQ Sample (.NET)