TDARemoteDataAdapter

Overview

The TDARemoteDataAdapter component forms the center of communication from the client to the server. It provides all the logic for retrieving data into TDADataTables, applying changes (Deltas) back to the server and handling any other data-related communication with the server such as retrieving business rules scripts or schema information.

The adapter contains four specialized TDARemoteDataAdapterRequests to configure how communication with the server is handled. These requests can handle talking to the standard v3.0 or v4.0 service interfaces out of the box, or can be configured to any custom server interface you might be using, with Dynamic Method Binding (Delphi).

Location

 

constructor Create  override

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

ApplyUpdates  override    (declared in TDABaseDataAdapter)

Applies local updates, which are represented in the collection of data tables, back to the server and returns true if the updates were successfully applied on the server. Otherwise returns false.

function ApplyUpdates(aTables: array of TDADataTable; aRefetchAll: boolean): boolean

Parameters:

  • aTables: Input collection of data tables with updates that should be applied on the server.
  • aRefetchAll: True: the data tables reopen after applying updates on the server. False: they don't reopen. By default, this parameter equals False.

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

AutoFillScripts    (declared in TDABaseDataAdapter)

Autofills business rules scripts at opening tables

property AutoFillScripts: Boolean read write

BeginApplyUpdates

function BeginApplyUpdates(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aTables:

BeginFill (TROAsyncCallback, Pointer, array of TDADataTable, Boolean, Boolean, Boolean): IROAsyncRequest  overload

function BeginFill(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable; aSaveCursor: Boolean; aIncludeSchema: Boolean; aAppendMode: Boolean): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aTables:
  • aSaveCursor:
  • aIncludeSchema:
  • aAppendMode:

BeginFill (TROAsyncCallback, Pointer, array of TDADataTable, TDAWhereExpressionArray, Boolean, Boolean, Boolean): IROAsyncRequest  overload

function BeginFill(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable; aWhereClauses: TDAWhereExpressionArray; aSaveCursor: Boolean; aIncludeSchema: Boolean; aAppendMode: Boolean): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aTables:
  • aWhereClauses:
  • aSaveCursor:
  • aIncludeSchema:
  • aAppendMode:

BeginFillSchema

function BeginFillSchema(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable; aPreserveLookupFields: boolean; aPreserveClientCalcFields: boolean): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aTables:
  • aPreserveLookupFields:
  • aPreserveClientCalcFields:

BeginFillScripts

function BeginFillScripts(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aTables:

BeginLogin (TROAsyncCallback, Pointer): IROAsyncRequest  overload

function BeginLogin(aCallback: TROAsyncCallback; aUserData: Pointer): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:

BeginLogin (TROAsyncCallback, Pointer, string): IROAsyncRequest  overload

function BeginLogin(aCallback: TROAsyncCallback; aUserData: Pointer; aLoginString: string): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aLoginString:

BeginLogin (TROAsyncCallback, Pointer, string, string): IROAsyncRequest  overload

function BeginLogin(aCallback: TROAsyncCallback; aUserData: Pointer; aUserName: string; aPassword: string): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aUserName:
  • aPassword:

BeginLogout

function BeginLogout(aCallback: TROAsyncCallback; aUserData: Pointer): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:

CacheSchema

Toggles whether the data adapter will maintain a local cache of the schema retrieved from the server with subsequent calls to the Schema property. If set to true, the adapter will download the schema the first time the Schema property is accessed, and subsequent accesses will return the same schema instance. If set to false (default), the schema will be re-downloaded from the server every time. You can flush any cached schema by setting this property to false and then immediately back to true, or by calling the FlushSchema method. Set this property to false when you expect frequent changes in the schema information, or when you want to update data tables to a changed server, at design time. Set it to true you want your application to only obtain the schema once and don't expect the server-side schema to change while the application is running.

property CacheSchema:

CheckProperties  override

Validates the data adapter properties.

procedure CheckProperties(ACheckOnlyDataStreamer: Boolean)

Parameters:

  • ACheckOnlyDataStreamer: True if only the data streamer should be checked, otherwise False. By default, this parameter equals False.

CreateTableRequestInfo  protected    (declared in TDABaseDataAdapter)

Generates TableRequestInfo based on given parameters.

function CreateTableRequestInfo(aTable: TDADataTable; aIncludeSchema: boolean; aDynamicWhereExpression: TDAWhereExpression): TableRequestInfo

Parameters:

  • aTable: datatable
  • aIncludeSchema: include schema
  • aDynamicWhereExpression: dynamic where expression

DataServiceName

property DataServiceName: string read write

DataStreamer

Defines the type of data streamer to be used for reading and writing data from and to the network. The type of streamer assigned here must match the streamer used on the ServiceDataStreamer property of the sever in the descendant classes.

property DataStreamer:

DynamicSelect    (declared in TDABaseDataAdapter)

Flag indicating whether Data Adapter should perform queries using the Dynamic Select feature.

property DynamicSelect: Boolean read write

EndApplyUpdates

procedure EndApplyUpdates(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

EndFill

procedure EndFill(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

EndFillSchema

procedure EndFillSchema(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

EndFillScripts

procedure EndFillScripts(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

EndLogin

function EndLogin(const aRequest: IROAsyncRequest): Boolean

Parameters:

  • aRequest:

EndLogout

procedure EndLogout(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

FailureBehavior    (declared in TDABaseDataAdapter)

Manages how TDABaseRemoteDataAdapter behaves when an error is encountered.

property FailureBehavior: TDAFailureBehavior read write

Fill (array of TDADataTable, array of TableRequestInfo, boolean, boolean, Boolean)  overload    (declared in TDABaseDataAdapter)

Retrieves data from the server for all of the specified TDADataTables. In most scenarios you will not call this method yourself, but simply open the respective data table, causing data to be retrieved automatically. However, calling Fill yourself provides additional flexibility, including the option to fill multiple data tables at the same time, avoiding unnecessary server round-trips.

procedure Fill(aTables: array of TDADataTable; aTableRequestInfoArray: array of TableRequestInfo; aSaveCursor: boolean; aIncludeSchema: boolean; aAppendMode: Boolean)

Parameters:

  • aTables: The specified collection of data tables that should receive the data from the server.
  • aTableRequestInfoArray: The specified collection of TableRequestInfo that contains additional parameters.
  • aSaveCursor: Defines whether the cursors that are related with the collection of data tables should be saved (true) or not (false).
  • aIncludeSchema: Defines whether the schema should be included while creating table request information (true) or not (false).
  • aAppendMode: Defines whether the AppendMode in the related TDATableOptionsArray collection should be set (true) or not (false). By default, this parameter equals false.

Fill (array of TDADataTable, array of TDAWhereExpression, boolean, boolean, Boolean)  overload    (declared in TDABaseDataAdapter)

Retrieves data from the server for all of the specified TDADataTables. In most scenarios you will not call this method yourself, but simply open the respective data table, causing data to be retrieved automatically. However, calling Fill yourself provides additional flexibility, including the option to fill multiple data tables at the same time, avoiding unnecessary server round-trips.

procedure Fill(aTables: array of TDADataTable; aWhereClauses: array of TDAWhereExpression; aSaveCursor: boolean; aIncludeSchema: boolean; aAppendMode: Boolean)

Parameters:

  • aTables: The specified collection of data tables that should receive the data from the server.
  • aWhereClauses: The specified collection of where clasuses that should receive the data from the server.
  • aSaveCursor: Defines whether the cursors that are related with the collection of data tables should be saved (true) or not (false).
  • aIncludeSchema: Defines whether the schema should be included while creating table request information (true) or not (false).
  • aAppendMode: Defines whether the AppendMode in the related TDATableOptionsArray collection should be set (true) or not (false). By default, this parameter equals false.

Fill (array of TDADataTable, boolean, boolean, Boolean)  overload override    (declared in TDABaseDataAdapter)

Retrieves data from the server for all of the specified TDADataTables. In most scenarios you will not call this method yourself, but simply open the respective data table, causing data to be retrieved automatically. However, calling Fill yourself provides additional flexibility, including the option to fill multiple data tables at the same time, avoiding unnecessary server round-trips.

procedure Fill(aTables: array of TDADataTable; aSaveCursor: boolean; aIncludeSchema: boolean; aAppendMode: Boolean)

Parameters:

  • aTables: The specified collection of data tables that should receive the data from the server.
  • aSaveCursor: Defines whether the cursors that are related with the collection of data tables should be saved (true) or not (false).
  • aIncludeSchema: Defines whether the schema should be included while creating table request information (true) or not (false).
  • aAppendMode: Defines whether the AppendMode in the related TDATableOptionsArray collection should be set (true) or not (false). By default, this parameter equals false.

FillSchema  override    (declared in TDABaseDataAdapter)

Retrieves schema information for all specified TDADataTables, and configures their Fields and Params setup to match the schema from the server. You can perform the same task at design-time for individual data tables by right-clicking the data table component and selecting "Retrieve DataTable Schema" from the context menu.

procedure FillSchema(aTables: array of TDADataTable; aPreserveLookupFields: boolean; aPreserveClientCalcFields: boolean)

Parameters:

  • aTables: The specified collection of data tables that should receive the schema information.
  • aPreserveLookupFields: Defines whether the collection of lookup fields should be preserved (true) or not (false). By default, this parameter equals false
  • aPreserveClientCalcFields: Defines whether the collection of calculated fields should be reserved (true) or not (false). By default, this parameter equals false

FillScripts  override    (declared in TDABaseDataAdapter)

Retrieves business rules scripts for all specified TDADataTables from the server.

procedure FillScripts(aTables: array of TDADataTable)

Parameters:


FillWithDASql (array of TDADataTable, array of string)  overload    (declared in TDABaseDataAdapter)

The method fills given data tables with the data from the server with a glance of SQL strings using TableRequestInfoV6 with DA SQL under the hood.

Note: works only with .NET servers

procedure FillWithDASql(aTables: array of TDADataTable; aSQLs: array of string)

Parameters:

  • aTables: The specified collection of data tables that should receive the data from the server.
  • aSQLs: A DA SQL query strings.

FillWithDASql (array of TDADataTable, array of string, array of DataParameterArray)  overload    (declared in TDABaseDataAdapter)

The method fills given data tables with the data from the server with a glance of SQL strings using TableRequestInfoV6 with DA SQL under the hood.

Note: works only with .NET servers

procedure FillWithDASql(aTables: array of TDADataTable; aSQLs: array of string; aParameters: array of DataParameterArray)

Parameters:

  • aTables: The specified collection of data tables that should receive the data from the server.
  • aSQLs: A DA SQL query strings.
  • aParameters: The specified collection of parameters

FillWithDASql (TDADataTable, string, DataParameterArray)  overload    (declared in TDABaseDataAdapter)

The method fills given data table with the data from the server with a glance of SQL string using TableRequestInfoV6 with DA SQL under the hood.

Note: works only with .NET servers

procedure FillWithDASql(aTable: TDADataTable; aSQL: string; aParameters: DataParameterArray)

Parameters:

  • aTable: Data table that should receive the data from the server.
  • aSQL: A DA SQL query string.
  • aParameters: Parameters

FireAfterApplyUpdates  protected    (declared in TDABaseDataAdapter)

procedure FireAfterApplyUpdates(aTables: TDADataTableList)

Parameters:

  • aTables:

FireBeforeApplyUpdates  protected    (declared in TDABaseDataAdapter)

procedure FireBeforeApplyUpdates(aTables: TDADataTableList)

Parameters:

  • aTables:

FlushSchema    (declared in TDABaseDataAdapter)

Deletes schema

procedure FlushSchema

Get_GetDataCall  protected override

Describes the server call that will be used to fetch data from the server.
This function is only used for backward compatibility to provide access to this function in the legacy events in the TDADataTable.

function Get_GetDataCall: TDARemoteRequest

Get_GetSchemaCall  protected override

Describes the server call that will be used to obtain schema information from the server.
This function is only used for backward compatibility to provide access to this function in the legacy events in the TDADataTable.

function Get_GetSchemaCall: TDARemoteRequest

Get_GetScriptsCall  protected override

Gets access to the server call that will be used to download business rules scripts.
This function is only used for backward compatibility to provide access to this function in the legacy events in the TDADataTable

function Get_GetScriptsCall: TDARemoteRequest

Get_UpdateDataCall  protected override

Describes the server call that will be used to apply changes back to the server.
This function is only used for backward compatibility to provide access to this function in the legacy events in the TDADataTable.

function Get_UpdateDataCall: TDARemoteRequest

GetDataCall

Describes the server call that will be used to fetch data from the server. Please refer to the documentation for TDAGetDataRequest for more details on the individual sub-properties.

property GetDataCall: TDAGetDataRequest read write

GetLinkedTables    (declared in TDACustomDataAdapter)

Returns list of datatables that use given DataAdapter

function GetLinkedTables: TList<TComponent>

GetSchemaCall

Describes the server call that will be used to obtain schema info from the server. This call is mostly at design-time while setting up TDADataTables. Please refer to the documentation for TDAGetSchemaRequest for more details on the individual sub-properties.

property GetSchemaCall: TDAGetSchemaRequest read write

GetScriptsCall

Gets access to the server call that will be used to download business rules scripts. Please refer to the documentation for TDAGetScriptsRequest for more details on the individual sub-properties.

property GetScriptsCall: TDAGetScriptsRequest read write

GetTableNamesAsCommaText  protected    (declared in TDABaseDataAdapter)

Produces comma-separated list of table names

function GetTableNamesAsCommaText(aTableArray: array of TDADataTable): ROUTF8String

Parameters:

  • aTableArray: source

Login  overload

function Login: Boolean

Login (string): Boolean  overload

function Login(aLoginString: string): Boolean

Parameters:

  • aLoginString:

Login (string, string): Boolean  overload

function Login(aUserName: string; aPassword: string): Boolean

Parameters:

  • aUserName:
  • aPassword:

LoginServiceName

property LoginServiceName: string read write

LoginString

property LoginString: string read write

Logout

This method performs the log out.

procedure Logout

OnAfterApplyUpdates    (declared in TDABaseDataAdapter)

Fires directly after the adapter has finished applying updates for a specific data table.

property OnAfterApplyUpdates: TDAApplyUpdatesEvent read write
delegate: procedure OnAfterApplyUpdates(Sender: TObject; aTable: TDADataTable; const Delta: IDADelta)

OnAfterGetDataCall

Fires directly after the GetDataCall has been completed.

property OnAfterGetDataCall: TDARequestEvent read write
delegate: procedure OnAfterGetDataCall(Sender: TObject; Request: TRODynamicRequest)

OnAfterGetSchemaCall

Fires directly after the GetSchemaCall has been completed.

property OnAfterGetSchemaCall: TDARequestEvent read write
delegate: procedure OnAfterGetSchemaCall(Sender: TObject; Request: TRODynamicRequest)

OnAfterGetScriptsCall

Fires directly after the GetScriptsCall has been completed.

property OnAfterGetScriptsCall: TDARequestEvent read write
delegate: procedure OnAfterGetScriptsCall(Sender: TObject; Request: TRODynamicRequest)

OnAfterUpdateDataCall

Fires directly after the UpdateDataCall has been completed.

property OnAfterUpdateDataCall: TDARequestEvent read write
delegate: procedure OnAfterUpdateDataCall(Sender: TObject; Request: TRODynamicRequest)

OnBeforeApplyUpdates    (declared in TDABaseDataAdapter)

Fires directly before the adapter starts applying updates for a specific data table.

property OnBeforeApplyUpdates: TDAApplyUpdatesEvent read write
delegate: procedure OnBeforeApplyUpdates(Sender: TObject; aTable: TDADataTable; const Delta: IDADelta)

OnBeforeGetDataCall

Fires directly before the GetDataCall will be executed. You can use this event to perform last minute changes to the requests's parameters (such as filling any custom parameters your service might expect, when using Dynamic Method Binding.

property OnBeforeGetDataCall: TDARequestEvent read write
delegate: procedure OnBeforeGetDataCall(Sender: TObject; Request: TRODynamicRequest)

OnBeforeGetSchemaCall

Fires directly before the GetSchemaCall will be executed. You can use this event to perform last minute changes to the requests's parameters (such as filling any custom parameters your service might expect, when using Dynamic Method Binding (Delphi).

property OnBeforeGetSchemaCall: TDARequestEvent read write
delegate: procedure OnBeforeGetSchemaCall(Sender: TObject; Request: TRODynamicRequest)

OnBeforeGetScriptsCall

Fires directly before the GetScriptsCall will be executed. You can use this event to perform last minute changes to the requests's parameters (such as filling any custom parameters your service might expect, when using Dynamic Method Binding (Delphi).

property OnBeforeGetScriptsCall: TDARequestEvent read write
delegate: procedure OnBeforeGetScriptsCall(Sender: TObject; Request: TRODynamicRequest)

OnBeforeProcessFailures    (declared in TDABaseDataAdapter)

Fires before the adapter starts processing failures

property OnBeforeProcessFailures: TDABeforeProcessFailuresEvent read write
delegate: procedure OnBeforeProcessFailures(Sender: TObject; aTablesList: TDADataTableList; aFailedDeltas: TDADeltaChangeList; var aFailureBehavior: TDAFailureBehavior)

OnBeforeUpdateDataCall

Fires directly before the UpdateDataCall will be executed. You can use this event to perform last minute changes to the requests's parameters (such as filling any custom parameters your service might expect, when using Dynamic Method Binding (Delphi).

property OnBeforeUpdateDataCall: TDARequestEvent read write
delegate: procedure OnBeforeUpdateDataCall(Sender: TObject; Request: TRODynamicRequest)

OnGenerateLoginString

property OnGenerateLoginString: TDAGenerateLoginString read write
delegate: procedure OnGenerateLoginString(Sender: TObject; var aLoginString: string)

OnGenerateRecordMessage    (declared in TDABaseDataAdapter)

Allows to customize default error message

property OnGenerateRecordMessage: TDAOnGenerateRecordMessage read write
delegate: procedure OnGenerateRecordMessage(Sender: TObject; aChange: TDADeltaChange; ADatatable: TDADataTable; var aMessage: string)

OnLoginInfoRequired

property OnLoginInfoRequired: TDALoginInfoRequired read write
delegate: procedure OnLoginInfoRequired(Sender: TObject; var aUserName: string; var aPassword: string)

OnShowReconcileRecordInAppUI    (declared in TDABaseDataAdapter)

Fires before showing a ReconcileDialogDetails with detailed information about the selected error to the user. If handled, ReconcileDialogDetails will not be shown to the user.

property OnShowReconcileRecordInAppUI: TDAShowReconcileRecordInAppUIEvent read write
delegate: procedure OnShowReconcileRecordInAppUI(Sender: TObject; aChange: TDADeltaChange; aDatatable: TDADataTable; var aHandled: Boolean; var aAction: TDAReconcileDialogAction)

OnShowReconcleDialog    (declared in TDABaseDataAdapter)

Fires before showing a ReconcileDialogDetails with detailed information about the selected error to the user.

property OnShowReconcleDialog: TDAShowReconcleDialogEvent read write
delegate: procedure OnShowReconcleDialog(Sender: TObject; var AFailedDeltaList: TDADeltaChangeList; aTableList: TDADataTableList; var aHandled: boolean)

Password

Password

property Password: string read write

ReadSchema    (declared in TDABaseDataAdapter)

Downloads the Schema from the Data Abstract server .

function ReadSchema(aForceReRead: boolean): TDAClientSchema

Parameters:

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

ReconcileProvider    (declared in TDABaseDataAdapter)

Reconcile Dialog provider.

property ReconcileProvider: TDABaseReconcileProvider read write

RemoteService

Sets the data service that this adapter will communicate with.

property RemoteService: TRORemoteService read write

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

Schema    (declared in TDABaseDataAdapter)

Server's schema.

property Schema:

SetupDefaultRequest

Resets all four request objects to the default setup used for the new v4.0 service interface.

procedure SetupDefaultRequest

SetupDefaultRequestV3

Resets all four request objects to the default setup used for legacy v3.0 service interface.

procedure SetupDefaultRequestV3

TargetURI

property TargetURI: TROUri read write

TargetURL

property TargetURL: string read write

UpdateData  protected virtual    (declared in TDABaseDataAdapter)

Applies changes back to the server

procedure UpdateData(aDeltaList: IDeltaArray)

Parameters:

  • aDeltaList: Delta list.

UpdateDataCall

Describes the server call that will be used to apply changes back to the server. Please refer to the documentation for TDAUpdateDataRequest for more details on the individual sub-properties.

property UpdateDataCall: TDAUpdateDataRequest read write

UserName

property UserName: string read write

 

AutoFillScripts    (declared in TDABaseDataAdapter)

Autofills business rules scripts at opening tables

property AutoFillScripts: Boolean read write

CacheSchema

Toggles whether the data adapter will maintain a local cache of the schema retrieved from the server with subsequent calls to the Schema property. If set to true, the adapter will download the schema the first time the Schema property is accessed, and subsequent accesses will return the same schema instance. If set to false (default), the schema will be re-downloaded from the server every time. You can flush any cached schema by setting this property to false and then immediately back to true, or by calling the FlushSchema method. Set this property to false when you expect frequent changes in the schema information, or when you want to update data tables to a changed server, at design time. Set it to true you want your application to only obtain the schema once and don't expect the server-side schema to change while the application is running.

property CacheSchema:

DataServiceName

property DataServiceName: string read write

DataStreamer

Defines the type of data streamer to be used for reading and writing data from and to the network. The type of streamer assigned here must match the streamer used on the ServiceDataStreamer property of the sever in the descendant classes.

property DataStreamer:

DynamicSelect    (declared in TDABaseDataAdapter)

Flag indicating whether Data Adapter should perform queries using the Dynamic Select feature.

property DynamicSelect: Boolean read write

FailureBehavior    (declared in TDABaseDataAdapter)

Manages how TDABaseRemoteDataAdapter behaves when an error is encountered.

property FailureBehavior: TDAFailureBehavior read write

GetDataCall

Describes the server call that will be used to fetch data from the server. Please refer to the documentation for TDAGetDataRequest for more details on the individual sub-properties.

property GetDataCall: TDAGetDataRequest read write

GetSchemaCall

Describes the server call that will be used to obtain schema info from the server. This call is mostly at design-time while setting up TDADataTables. Please refer to the documentation for TDAGetSchemaRequest for more details on the individual sub-properties.

property GetSchemaCall: TDAGetSchemaRequest read write

GetScriptsCall

Gets access to the server call that will be used to download business rules scripts. Please refer to the documentation for TDAGetScriptsRequest for more details on the individual sub-properties.

property GetScriptsCall: TDAGetScriptsRequest read write

LoginServiceName

property LoginServiceName: string read write

LoginString

property LoginString: string read write

Password

Password

property Password: string read write

ReconcileProvider    (declared in TDABaseDataAdapter)

Reconcile Dialog provider.

property ReconcileProvider: TDABaseReconcileProvider read write

RemoteService

Sets the data service that this adapter will communicate with.

property RemoteService: TRORemoteService read write

Schema    (declared in TDABaseDataAdapter)

Server's schema.

property Schema:

TargetURI

property TargetURI: TROUri read write

TargetURL

property TargetURL: string read write

UpdateDataCall

Describes the server call that will be used to apply changes back to the server. Please refer to the documentation for TDAUpdateDataRequest for more details on the individual sub-properties.

property UpdateDataCall: TDAUpdateDataRequest read write

UserName

property UserName: string read write

 

constructor Create  override

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

ApplyUpdates  override    (declared in TDABaseDataAdapter)

Applies local updates, which are represented in the collection of data tables, back to the server and returns true if the updates were successfully applied on the server. Otherwise returns false.

function ApplyUpdates(aTables: array of TDADataTable; aRefetchAll: boolean): boolean

Parameters:

  • aTables: Input collection of data tables with updates that should be applied on the server.
  • aRefetchAll: True: the data tables reopen after applying updates on the server. False: they don't reopen. By default, this parameter equals False.

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

BeginApplyUpdates

function BeginApplyUpdates(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aTables:

BeginFill (TROAsyncCallback, Pointer, array of TDADataTable, Boolean, Boolean, Boolean): IROAsyncRequest  overload

function BeginFill(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable; aSaveCursor: Boolean; aIncludeSchema: Boolean; aAppendMode: Boolean): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aTables:
  • aSaveCursor:
  • aIncludeSchema:
  • aAppendMode:

BeginFill (TROAsyncCallback, Pointer, array of TDADataTable, TDAWhereExpressionArray, Boolean, Boolean, Boolean): IROAsyncRequest  overload

function BeginFill(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable; aWhereClauses: TDAWhereExpressionArray; aSaveCursor: Boolean; aIncludeSchema: Boolean; aAppendMode: Boolean): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aTables:
  • aWhereClauses:
  • aSaveCursor:
  • aIncludeSchema:
  • aAppendMode:

BeginFillSchema

function BeginFillSchema(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable; aPreserveLookupFields: boolean; aPreserveClientCalcFields: boolean): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aTables:
  • aPreserveLookupFields:
  • aPreserveClientCalcFields:

BeginFillScripts

function BeginFillScripts(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aTables:

BeginLogin (TROAsyncCallback, Pointer): IROAsyncRequest  overload

function BeginLogin(aCallback: TROAsyncCallback; aUserData: Pointer): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:

BeginLogin (TROAsyncCallback, Pointer, string): IROAsyncRequest  overload

function BeginLogin(aCallback: TROAsyncCallback; aUserData: Pointer; aLoginString: string): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aLoginString:

BeginLogin (TROAsyncCallback, Pointer, string, string): IROAsyncRequest  overload

function BeginLogin(aCallback: TROAsyncCallback; aUserData: Pointer; aUserName: string; aPassword: string): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:
  • aUserName:
  • aPassword:

BeginLogout

function BeginLogout(aCallback: TROAsyncCallback; aUserData: Pointer): IROAsyncRequest

Parameters:

  • aCallback:
  • aUserData:

CheckProperties  override

Validates the data adapter properties.

procedure CheckProperties(ACheckOnlyDataStreamer: Boolean)

Parameters:

  • ACheckOnlyDataStreamer: True if only the data streamer should be checked, otherwise False. By default, this parameter equals False.

CreateTableRequestInfo  protected    (declared in TDABaseDataAdapter)

Generates TableRequestInfo based on given parameters.

function CreateTableRequestInfo(aTable: TDADataTable; aIncludeSchema: boolean; aDynamicWhereExpression: TDAWhereExpression): TableRequestInfo

Parameters:

  • aTable: datatable
  • aIncludeSchema: include schema
  • aDynamicWhereExpression: dynamic where expression

EndApplyUpdates

procedure EndApplyUpdates(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

EndFill

procedure EndFill(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

EndFillSchema

procedure EndFillSchema(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

EndFillScripts

procedure EndFillScripts(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

EndLogin

function EndLogin(const aRequest: IROAsyncRequest): Boolean

Parameters:

  • aRequest:

EndLogout

procedure EndLogout(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

Fill (array of TDADataTable, array of TableRequestInfo, boolean, boolean, Boolean)  overload    (declared in TDABaseDataAdapter)

Retrieves data from the server for all of the specified TDADataTables. In most scenarios you will not call this method yourself, but simply open the respective data table, causing data to be retrieved automatically. However, calling Fill yourself provides additional flexibility, including the option to fill multiple data tables at the same time, avoiding unnecessary server round-trips.

procedure Fill(aTables: array of TDADataTable; aTableRequestInfoArray: array of TableRequestInfo; aSaveCursor: boolean; aIncludeSchema: boolean; aAppendMode: Boolean)

Parameters:

  • aTables: The specified collection of data tables that should receive the data from the server.
  • aTableRequestInfoArray: The specified collection of TableRequestInfo that contains additional parameters.
  • aSaveCursor: Defines whether the cursors that are related with the collection of data tables should be saved (true) or not (false).
  • aIncludeSchema: Defines whether the schema should be included while creating table request information (true) or not (false).
  • aAppendMode: Defines whether the AppendMode in the related TDATableOptionsArray collection should be set (true) or not (false). By default, this parameter equals false.

Fill (array of TDADataTable, array of TDAWhereExpression, boolean, boolean, Boolean)  overload    (declared in TDABaseDataAdapter)

Retrieves data from the server for all of the specified TDADataTables. In most scenarios you will not call this method yourself, but simply open the respective data table, causing data to be retrieved automatically. However, calling Fill yourself provides additional flexibility, including the option to fill multiple data tables at the same time, avoiding unnecessary server round-trips.

procedure Fill(aTables: array of TDADataTable; aWhereClauses: array of TDAWhereExpression; aSaveCursor: boolean; aIncludeSchema: boolean; aAppendMode: Boolean)

Parameters:

  • aTables: The specified collection of data tables that should receive the data from the server.
  • aWhereClauses: The specified collection of where clasuses that should receive the data from the server.
  • aSaveCursor: Defines whether the cursors that are related with the collection of data tables should be saved (true) or not (false).
  • aIncludeSchema: Defines whether the schema should be included while creating table request information (true) or not (false).
  • aAppendMode: Defines whether the AppendMode in the related TDATableOptionsArray collection should be set (true) or not (false). By default, this parameter equals false.

Fill (array of TDADataTable, boolean, boolean, Boolean)  overload override    (declared in TDABaseDataAdapter)

Retrieves data from the server for all of the specified TDADataTables. In most scenarios you will not call this method yourself, but simply open the respective data table, causing data to be retrieved automatically. However, calling Fill yourself provides additional flexibility, including the option to fill multiple data tables at the same time, avoiding unnecessary server round-trips.

procedure Fill(aTables: array of TDADataTable; aSaveCursor: boolean; aIncludeSchema: boolean; aAppendMode: Boolean)

Parameters:

  • aTables: The specified collection of data tables that should receive the data from the server.
  • aSaveCursor: Defines whether the cursors that are related with the collection of data tables should be saved (true) or not (false).
  • aIncludeSchema: Defines whether the schema should be included while creating table request information (true) or not (false).
  • aAppendMode: Defines whether the AppendMode in the related TDATableOptionsArray collection should be set (true) or not (false). By default, this parameter equals false.

FillSchema  override    (declared in TDABaseDataAdapter)

Retrieves schema information for all specified TDADataTables, and configures their Fields and Params setup to match the schema from the server. You can perform the same task at design-time for individual data tables by right-clicking the data table component and selecting "Retrieve DataTable Schema" from the context menu.

procedure FillSchema(aTables: array of TDADataTable; aPreserveLookupFields: boolean; aPreserveClientCalcFields: boolean)

Parameters:

  • aTables: The specified collection of data tables that should receive the schema information.
  • aPreserveLookupFields: Defines whether the collection of lookup fields should be preserved (true) or not (false). By default, this parameter equals false
  • aPreserveClientCalcFields: Defines whether the collection of calculated fields should be reserved (true) or not (false). By default, this parameter equals false

FillScripts  override    (declared in TDABaseDataAdapter)

Retrieves business rules scripts for all specified TDADataTables from the server.

procedure FillScripts(aTables: array of TDADataTable)

Parameters:


FillWithDASql (array of TDADataTable, array of string)  overload    (declared in TDABaseDataAdapter)

The method fills given data tables with the data from the server with a glance of SQL strings using TableRequestInfoV6 with DA SQL under the hood.

Note: works only with .NET servers

procedure FillWithDASql(aTables: array of TDADataTable; aSQLs: array of string)

Parameters:

  • aTables: The specified collection of data tables that should receive the data from the server.
  • aSQLs: A DA SQL query strings.

FillWithDASql (array of TDADataTable, array of string, array of DataParameterArray)  overload    (declared in TDABaseDataAdapter)

The method fills given data tables with the data from the server with a glance of SQL strings using TableRequestInfoV6 with DA SQL under the hood.

Note: works only with .NET servers

procedure FillWithDASql(aTables: array of TDADataTable; aSQLs: array of string; aParameters: array of DataParameterArray)

Parameters:

  • aTables: The specified collection of data tables that should receive the data from the server.
  • aSQLs: A DA SQL query strings.
  • aParameters: The specified collection of parameters

FillWithDASql (TDADataTable, string, DataParameterArray)  overload    (declared in TDABaseDataAdapter)

The method fills given data table with the data from the server with a glance of SQL string using TableRequestInfoV6 with DA SQL under the hood.

Note: works only with .NET servers

procedure FillWithDASql(aTable: TDADataTable; aSQL: string; aParameters: DataParameterArray)

Parameters:

  • aTable: Data table that should receive the data from the server.
  • aSQL: A DA SQL query string.
  • aParameters: Parameters

FireAfterApplyUpdates  protected    (declared in TDABaseDataAdapter)

procedure FireAfterApplyUpdates(aTables: TDADataTableList)

Parameters:

  • aTables:

FireBeforeApplyUpdates  protected    (declared in TDABaseDataAdapter)

procedure FireBeforeApplyUpdates(aTables: TDADataTableList)

Parameters:

  • aTables:

FlushSchema    (declared in TDABaseDataAdapter)

Deletes schema

procedure FlushSchema

Get_GetDataCall  protected override

Describes the server call that will be used to fetch data from the server.
This function is only used for backward compatibility to provide access to this function in the legacy events in the TDADataTable.

function Get_GetDataCall: TDARemoteRequest

Get_GetSchemaCall  protected override

Describes the server call that will be used to obtain schema information from the server.
This function is only used for backward compatibility to provide access to this function in the legacy events in the TDADataTable.

function Get_GetSchemaCall: TDARemoteRequest

Get_GetScriptsCall  protected override

Gets access to the server call that will be used to download business rules scripts.
This function is only used for backward compatibility to provide access to this function in the legacy events in the TDADataTable

function Get_GetScriptsCall: TDARemoteRequest

Get_UpdateDataCall  protected override

Describes the server call that will be used to apply changes back to the server.
This function is only used for backward compatibility to provide access to this function in the legacy events in the TDADataTable.

function Get_UpdateDataCall: TDARemoteRequest

GetLinkedTables    (declared in TDACustomDataAdapter)

Returns list of datatables that use given DataAdapter

function GetLinkedTables: TList<TComponent>

GetTableNamesAsCommaText  protected    (declared in TDABaseDataAdapter)

Produces comma-separated list of table names

function GetTableNamesAsCommaText(aTableArray: array of TDADataTable): ROUTF8String

Parameters:

  • aTableArray: source

Login  overload

function Login: Boolean

Login (string): Boolean  overload

function Login(aLoginString: string): Boolean

Parameters:

  • aLoginString:

Login (string, string): Boolean  overload

function Login(aUserName: string; aPassword: string): Boolean

Parameters:

  • aUserName:
  • aPassword:

Logout

This method performs the log out.

procedure Logout

ReadSchema    (declared in TDABaseDataAdapter)

Downloads the Schema from the Data Abstract server .

function ReadSchema(aForceReRead: boolean): TDAClientSchema

Parameters:

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

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

SetupDefaultRequest

Resets all four request objects to the default setup used for the new v4.0 service interface.

procedure SetupDefaultRequest

SetupDefaultRequestV3

Resets all four request objects to the default setup used for legacy v3.0 service interface.

procedure SetupDefaultRequestV3

UpdateData  protected virtual    (declared in TDABaseDataAdapter)

Applies changes back to the server

procedure UpdateData(aDeltaList: IDeltaArray)

Parameters:

  • aDeltaList: Delta list.

 

OnAfterApplyUpdates    (declared in TDABaseDataAdapter)

Fires directly after the adapter has finished applying updates for a specific data table.

property OnAfterApplyUpdates: TDAApplyUpdatesEvent read write
delegate: procedure OnAfterApplyUpdates(Sender: TObject; aTable: TDADataTable; const Delta: IDADelta)

OnAfterGetDataCall

Fires directly after the GetDataCall has been completed.

property OnAfterGetDataCall: TDARequestEvent read write
delegate: procedure OnAfterGetDataCall(Sender: TObject; Request: TRODynamicRequest)

OnAfterGetSchemaCall

Fires directly after the GetSchemaCall has been completed.

property OnAfterGetSchemaCall: TDARequestEvent read write
delegate: procedure OnAfterGetSchemaCall(Sender: TObject; Request: TRODynamicRequest)

OnAfterGetScriptsCall

Fires directly after the GetScriptsCall has been completed.

property OnAfterGetScriptsCall: TDARequestEvent read write
delegate: procedure OnAfterGetScriptsCall(Sender: TObject; Request: TRODynamicRequest)

OnAfterUpdateDataCall

Fires directly after the UpdateDataCall has been completed.

property OnAfterUpdateDataCall: TDARequestEvent read write
delegate: procedure OnAfterUpdateDataCall(Sender: TObject; Request: TRODynamicRequest)

OnBeforeApplyUpdates    (declared in TDABaseDataAdapter)

Fires directly before the adapter starts applying updates for a specific data table.

property OnBeforeApplyUpdates: TDAApplyUpdatesEvent read write
delegate: procedure OnBeforeApplyUpdates(Sender: TObject; aTable: TDADataTable; const Delta: IDADelta)

OnBeforeGetDataCall

Fires directly before the GetDataCall will be executed. You can use this event to perform last minute changes to the requests's parameters (such as filling any custom parameters your service might expect, when using Dynamic Method Binding.

property OnBeforeGetDataCall: TDARequestEvent read write
delegate: procedure OnBeforeGetDataCall(Sender: TObject; Request: TRODynamicRequest)

OnBeforeGetSchemaCall

Fires directly before the GetSchemaCall will be executed. You can use this event to perform last minute changes to the requests's parameters (such as filling any custom parameters your service might expect, when using Dynamic Method Binding (Delphi).

property OnBeforeGetSchemaCall: TDARequestEvent read write
delegate: procedure OnBeforeGetSchemaCall(Sender: TObject; Request: TRODynamicRequest)

OnBeforeGetScriptsCall

Fires directly before the GetScriptsCall will be executed. You can use this event to perform last minute changes to the requests's parameters (such as filling any custom parameters your service might expect, when using Dynamic Method Binding (Delphi).

property OnBeforeGetScriptsCall: TDARequestEvent read write
delegate: procedure OnBeforeGetScriptsCall(Sender: TObject; Request: TRODynamicRequest)

OnBeforeProcessFailures    (declared in TDABaseDataAdapter)

Fires before the adapter starts processing failures

property OnBeforeProcessFailures: TDABeforeProcessFailuresEvent read write
delegate: procedure OnBeforeProcessFailures(Sender: TObject; aTablesList: TDADataTableList; aFailedDeltas: TDADeltaChangeList; var aFailureBehavior: TDAFailureBehavior)

OnBeforeUpdateDataCall

Fires directly before the UpdateDataCall will be executed. You can use this event to perform last minute changes to the requests's parameters (such as filling any custom parameters your service might expect, when using Dynamic Method Binding (Delphi).

property OnBeforeUpdateDataCall: TDARequestEvent read write
delegate: procedure OnBeforeUpdateDataCall(Sender: TObject; Request: TRODynamicRequest)

OnGenerateLoginString

property OnGenerateLoginString: TDAGenerateLoginString read write
delegate: procedure OnGenerateLoginString(Sender: TObject; var aLoginString: string)

OnGenerateRecordMessage    (declared in TDABaseDataAdapter)

Allows to customize default error message

property OnGenerateRecordMessage: TDAOnGenerateRecordMessage read write
delegate: procedure OnGenerateRecordMessage(Sender: TObject; aChange: TDADeltaChange; ADatatable: TDADataTable; var aMessage: string)

OnLoginInfoRequired

property OnLoginInfoRequired: TDALoginInfoRequired read write
delegate: procedure OnLoginInfoRequired(Sender: TObject; var aUserName: string; var aPassword: string)

OnShowReconcileRecordInAppUI    (declared in TDABaseDataAdapter)

Fires before showing a ReconcileDialogDetails with detailed information about the selected error to the user. If handled, ReconcileDialogDetails will not be shown to the user.

property OnShowReconcileRecordInAppUI: TDAShowReconcileRecordInAppUIEvent read write
delegate: procedure OnShowReconcileRecordInAppUI(Sender: TObject; aChange: TDADeltaChange; aDatatable: TDADataTable; var aHandled: Boolean; var aAction: TDAReconcileDialogAction)

OnShowReconcleDialog    (declared in TDABaseDataAdapter)

Fires before showing a ReconcileDialogDetails with detailed information about the selected error to the user.

property OnShowReconcleDialog: TDAShowReconcleDialogEvent read write
delegate: procedure OnShowReconcleDialog(Sender: TObject; var AFailedDeltaList: TDADeltaChangeList; aTableList: TDADataTableList; var aHandled: boolean)