TDARemoteDataAdapter

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

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.

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Autofills business rules scripts at opening tables

property AutoFillScripts: Boolean read write

---

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

Parameters:

• aCallback:
• aUserData:
• aTables:

---

function BeginApplyUpdates(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aTables: array of TDADataTable): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aTables:

---

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

Parameters:

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

---

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:

---

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

Parameters:

• aCallbackMethod:
• aUserData:
• aTables:
• aSaveCursor:
• aIncludeSchema:
• aAppendMode:

---

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

Parameters:

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

---

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

Parameters:

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

---

function BeginFillSchema(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aTables: array of TDADataTable; aPreserveLookupFields: Boolean; aPreserveClientCalcFields: Boolean): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aTables:
• aPreserveLookupFields:
• aPreserveClientCalcFields:

---

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

Parameters:

• aCallback:
• aUserData:
• aTables:

---

function BeginFillScripts(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aTables: array of TDADataTable): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aTables:

---

function BeginFillWithDASql(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable; aSQLs: array of string; aParameters: array of DataParameterArray): IROAsyncRequest

Parameters:

• aCallback:
• aUserData:
• aTables:
• aSQLs:
• aParameters:

---

function BeginFillWithDASql(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aTables: array of TDADataTable; aSQLs: array of string; aParameters: array of DataParameterArray): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aTables:
• aSQLs:
• aParameters:

---

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

Parameters:

• aCallback:
• aUserData:

---

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

Parameters:

• aCallback:
• aUserData:
• aLoginString:

---

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

Parameters:

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

---

function BeginLogin(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:

---

function BeginLogin(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aLoginString: string): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aLoginString:

---

function BeginLogin(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aUserName: string; aPassword: string): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aUserName:
• aPassword:

---

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

Parameters:

• aCallback:
• aUserData:

---

function BeginLogout(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:

---

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: Boolean read write

---

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.

---

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

---

property DataServiceName: string read write

---

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: TDADataStreamer read write

---

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

property DynamicSelect: Boolean read write

---

procedure EndApplyUpdates(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

procedure EndFill(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

procedure EndFillSchema(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

procedure EndFillScripts(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

procedure EndFillWithDASql(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

function EndLogin(const aRequest: IROAsyncRequest): Boolean

Parameters:

• aRequest:

---

procedure EndLogout(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

Executes the command with the given name and returns the number of affected rows.

function Execute(aCommandName: string): Integer

Parameters:

• aCommandName: Name of the command that is declared in the schema.

---

Executes the command with the given input parameters and returns the number of affected rows.

function Execute(aCommandName: string; aInputParameters: array of Variant): Integer

Parameters:

• aCommandName: Name of the command that is declared in the schema.
• aInputParameters: Specified array with input parameters.

---

Executes the command with the given name and input parameters and returns the number of affected rows.

function Execute(aCommandName: string; aInputParameters: DataParameterArray): Integer

Parameters:

• aCommandName: Name of the command that is declared in the schema.
• aInputParameters: Specified array with input parameters.

---

Executes the command with the given name and input parameters and returns the number of affected rows.

function Execute(aCommandName: string; aInputParameters: DataParameterArray; out aOutputParameters: DataParameterArray): Integer

Parameters:

• aCommandName: Name of the command that is declared in the schema.
• aInputParameters: Specified array with input parameters.
• aOutputParameters: Specified array with output parameters.

---

Manages how TDABaseRemoteDataAdapter behaves when an error is encountered.

property FailureBehavior: TDAFailureBehavior read write

---

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.

---

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: TableRequestInfoArray_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.

---

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.

---

Retrieves schema information for all of the specified TDADataTable, 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:
• aPreserveLookupFields:
• aPreserveClientCalcFields:

---

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; areserveClientCalcFields: 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
• areserveClientCalcFields: Defines whether the collection of calculated fields should be reserved (true) or not (false). By default, this parameter equals false

---

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

procedure FillScripts(aTables: array of TDADataTable)

Parameters:

• aTables: The specified collection of data tables that should receive business rules scripts.

---

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

---

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.

---

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

---

procedure FireAfterApplyUpdates(aTables: TDADataTableList)

Parameters:

• aTables:

---

procedure FireBeforeApplyUpdates(aTables: TDADataTableList)

Parameters:

• aTables:

---

Deletes schema

procedure FlushSchema

---

function GenerateTableRequestInfoArray_FillWithDASql(aTables: array of TDADataTable; aSQLs: array of string; aParameters: array of DataParameterArray): TableRequestInfoArray_TableRequestInfo

Parameters:

• aTables:
• aSQLs:
• aParameters:

---

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

---

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

---

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

---

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

---

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

---

Returns list of datatables that use given DataAdapter

function GetLinkedTables: TList<TComponent>

---

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

---

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

---

Produces comma-separated list of table names

function GetTableNamesAsCommaText(aTableArray: array of TDADataTable): ROUTF8String

Parameters:

• aTableArray: source

---

function IsSchemaExist: Boolean

---

function Login: Boolean

---

function Login(aLoginString: string): Boolean

Parameters:

• aLoginString:

---

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

Parameters:

• aUserName:
• aPassword:

---

property LoginServiceName: string read write

---

property LoginString: string read write

---

This method performs the log out.

procedure Logout

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

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)

---

Fires directly after the GetDataCall has been completed.

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

---

Fires directly after the GetSchemaCall has been completed.

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

---

Fires directly after the GetScriptsCall has been completed.

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

---

Fires directly after the UpdateDataCall has been completed.

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

---

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)

---

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)

---

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)

---

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)

---

Fires before the adapter starts processing failures

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

---

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)

---

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

---

Allows to customize default error message

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

---

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

---

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)

---

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

property Password: string read write

---

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

---

procedure ReadSchemaFromXML(aValue: ROUTF8String)

Parameters:

• aValue:

---

Reconcile Dialog provider.

property ReconcileProvider: TDABaseReconcileProvider read write

---

Sets the data service that this adapter will communicate with.

property RemoteService: TRORemoteService read write

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Server's schema.

property Schema: TDAClientSchema read

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

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

procedure SetupDefaultRequest

---

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

procedure SetupDefaultRequestV3

---

property TargetURI: TROUri read write

---

property TargetURL: string read write

---

Applies changes back to the server

procedure UpdateData(aDeltaList: IDeltaArray)

Parameters:

• aDeltaList: Delta list.

---

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

---

property UserName: string read write

 

Autofills business rules scripts at opening tables

property AutoFillScripts: Boolean read write

---

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: Boolean read write

---

property DataServiceName: string read write

---

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: TDADataStreamer read write

---

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

property DynamicSelect: Boolean read write

---

Manages how TDABaseRemoteDataAdapter behaves when an error is encountered.

property FailureBehavior: TDAFailureBehavior read write

---

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

---

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

---

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

---

property LoginServiceName: string read write

---

property LoginString: string read write

---

Password

property Password: string read write

---

Reconcile Dialog provider.

property ReconcileProvider: TDABaseReconcileProvider read write

---

Sets the data service that this adapter will communicate with.

property RemoteService: TRORemoteService read write

---

Server's schema.

property Schema: TDAClientSchema read

---

property TargetURI: TROUri read write

---

property TargetURL: string read write

---

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

---

property UserName: string read write

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

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.

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

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

Parameters:

• aCallback:
• aUserData:
• aTables:

---

function BeginApplyUpdates(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aTables: array of TDADataTable): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aTables:

---

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

Parameters:

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

---

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:

---

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

Parameters:

• aCallbackMethod:
• aUserData:
• aTables:
• aSaveCursor:
• aIncludeSchema:
• aAppendMode:

---

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

Parameters:

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

---

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

Parameters:

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

---

function BeginFillSchema(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aTables: array of TDADataTable; aPreserveLookupFields: Boolean; aPreserveClientCalcFields: Boolean): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aTables:
• aPreserveLookupFields:
• aPreserveClientCalcFields:

---

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

Parameters:

• aCallback:
• aUserData:
• aTables:

---

function BeginFillScripts(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aTables: array of TDADataTable): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aTables:

---

function BeginFillWithDASql(aCallback: TROAsyncCallback; aUserData: Pointer; aTables: array of TDADataTable; aSQLs: array of string; aParameters: array of DataParameterArray): IROAsyncRequest

Parameters:

• aCallback:
• aUserData:
• aTables:
• aSQLs:
• aParameters:

---

function BeginFillWithDASql(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aTables: array of TDADataTable; aSQLs: array of string; aParameters: array of DataParameterArray): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aTables:
• aSQLs:
• aParameters:

---

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

Parameters:

• aCallback:
• aUserData:

---

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

Parameters:

• aCallback:
• aUserData:
• aLoginString:

---

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

Parameters:

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

---

function BeginLogin(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:

---

function BeginLogin(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aLoginString: string): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aLoginString:

---

function BeginLogin(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer; aUserName: string; aPassword: string): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:
• aUserName:
• aPassword:

---

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

Parameters:

• aCallback:
• aUserData:

---

function BeginLogout(aCallbackMethod: TROAsyncCallbackMethod; aUserData: Pointer): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:

---

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.

---

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

---

procedure EndApplyUpdates(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

procedure EndFill(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

procedure EndFillSchema(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

procedure EndFillScripts(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

procedure EndFillWithDASql(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

function EndLogin(const aRequest: IROAsyncRequest): Boolean

Parameters:

• aRequest:

---

procedure EndLogout(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

Executes the command with the given name and returns the number of affected rows.

function Execute(aCommandName: string): Integer

Parameters:

• aCommandName: Name of the command that is declared in the schema.

---

Executes the command with the given input parameters and returns the number of affected rows.

function Execute(aCommandName: string; aInputParameters: array of Variant): Integer

Parameters:

• aCommandName: Name of the command that is declared in the schema.
• aInputParameters: Specified array with input parameters.

---

Executes the command with the given name and input parameters and returns the number of affected rows.

function Execute(aCommandName: string; aInputParameters: DataParameterArray): Integer

Parameters:

• aCommandName: Name of the command that is declared in the schema.
• aInputParameters: Specified array with input parameters.

---

Executes the command with the given name and input parameters and returns the number of affected rows.

function Execute(aCommandName: string; aInputParameters: DataParameterArray; out aOutputParameters: DataParameterArray): Integer

Parameters:

• aCommandName: Name of the command that is declared in the schema.
• aInputParameters: Specified array with input parameters.
• aOutputParameters: Specified array with output parameters.

---

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.

---

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: TableRequestInfoArray_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.

---

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.

---

Retrieves schema information for all of the specified TDADataTable, 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:
• aPreserveLookupFields:
• aPreserveClientCalcFields:

---

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; areserveClientCalcFields: 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
• areserveClientCalcFields: Defines whether the collection of calculated fields should be reserved (true) or not (false). By default, this parameter equals false

---

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

procedure FillScripts(aTables: array of TDADataTable)

Parameters:

• aTables: The specified collection of data tables that should receive business rules scripts.

---

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

---

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.

---

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

---

procedure FireAfterApplyUpdates(aTables: TDADataTableList)

Parameters:

• aTables:

---

procedure FireBeforeApplyUpdates(aTables: TDADataTableList)

Parameters:

• aTables:

---

Deletes schema

procedure FlushSchema

---

function GenerateTableRequestInfoArray_FillWithDASql(aTables: array of TDADataTable; aSQLs: array of string; aParameters: array of DataParameterArray): TableRequestInfoArray_TableRequestInfo

Parameters:

• aTables:
• aSQLs:
• aParameters:

---

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

---

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

---

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

---

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

---

Returns list of datatables that use given DataAdapter

function GetLinkedTables: TList<TComponent>

---

Produces comma-separated list of table names

function GetTableNamesAsCommaText(aTableArray: array of TDADataTable): ROUTF8String

Parameters:

• aTableArray: source

---

function IsSchemaExist: Boolean

---

function Login: Boolean

---

function Login(aLoginString: string): Boolean

Parameters:

• aLoginString:

---

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

Parameters:

• aUserName:
• aPassword:

---

This method performs the log out.

procedure Logout

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

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

---

procedure ReadSchemaFromXML(aValue: ROUTF8String)

Parameters:

• aValue:

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

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

procedure SetupDefaultRequest

---

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

procedure SetupDefaultRequestV3

---

Applies changes back to the server

procedure UpdateData(aDeltaList: IDeltaArray)

Parameters:

• aDeltaList: Delta list.

 

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)

---

Fires directly after the GetDataCall has been completed.

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

---

Fires directly after the GetSchemaCall has been completed.

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

---

Fires directly after the GetScriptsCall has been completed.

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

---

Fires directly after the UpdateDataCall has been completed.

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

---

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)

---

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)

---

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)

---

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)

---

Fires before the adapter starts processing failures

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

---

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)

---

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

---

Allows to customize default error message

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

---

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

---

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)

---

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)