IDataAbstractService

Overview

IDataAbstractService interface is a part of Data Abstract server interface and is used for working with remote data. This interface is implemented in DataAbstractService_Proxy class that is used by default in RemoteDataAdapter class. To change this, you need to implement this interface in order to pass to the RemoteDataAdapter your own data access implementation.

Location

Implemented in

Required Methods


ExecuteCommand

Executes the given command, initializing its parameters with the values contained in the given array. The command name needs to reference one of the commands in the schema associated with this service.

 

method ExecuteCommand(aCommandName: String; aParameterArray: DataParameterArray): Integer

 

Integer ExecuteCommand(String aCommandName, DataParameterArray aParameterArray)

Parameters:

  • aCommandName: The command name in the Schema.
  • aParameterArray: The list of input paramaters.

ExecuteCommandEx

Executes the given command, initializing its parameters with the values contained in the given array. The command name needs to reference one of the commands in the schema associated with this service.

 

method ExecuteCommandEx(aCommandName: String; aInputParameters: DataParameterArray; _aOutputParameters: ReferenceType<DataParameterArray>): Integer

 

Integer ExecuteCommandEx(String aCommandName, DataParameterArray aInputParameters, ReferenceType<DataParameterArray> _aOutputParameters)

Parameters:

  • aCommandName: The command name in the Schema.
  • aInputParameters: The list of input paramaters.
  • _aOutputParameters: The list of output paramaters.

GetCommandSchema

Returns the definitions of the schema commands identified by the names passed through the parameter.

 

method GetCommandSchema(aCommandNameArray: StringArray): String

 

String GetCommandSchema(StringArray aCommandNameArray)

Parameters:

  • aCommandNameArray: The aray of the names of schema commands.

GetData

Returns a stream that includes the data of all data tables indicated in the first parameter. Each data table can return a different number of rows, or be opened using specific parameters that are passed as TableInfoRequest in the second parameter.

 

method GetData(aTableNameArray: StringArray; aTableRequestInfoArray: TableRequestInfoArray): array of SByte

 

SByte[] GetData(StringArray aTableNameArray, TableRequestInfoArray aTableRequestInfoArray)

Parameters:

  • aTableNameArray: The set of table names.
  • aTableRequestInfoArray: The set of table request objects.

GetDatasetScripts

Returns tables scripts in XML format.

 

method GetDatasetScripts(DatasetNames: String): String

 

String GetDatasetScripts(String DatasetNames)

Parameters:

  • DatasetNames: List of dataset names which should be devided by comma

GetSchema

Returns the schema accordingto the filter specified filter.

 

method GetSchema(aFilter: String): String

 

String GetSchema(String aFilter)

Parameters:

  • aFilter: The filter string to use.

GetTableSchema

Returns the definitions of the schema data tables identified by the names passed through the parameter.

 

method GetTableSchema(aTableNameArray: StringArray): String

 

String GetTableSchema(StringArray aTableNameArray)

Parameters:

  • aTableNameArray: The array of table names.

RegisterForDataChangeNotification

Registers a new table which will be refreshed automatically after other users apply changes to it.

 

method RegisterForDataChangeNotification(aTableName: String)

 

void RegisterForDataChangeNotification(String aTableName)

Parameters:

  • aTableName: The name of the table that is to be subscribed for notifications.

SQLExecuteCommand

Executes the passed SQL statement as a command.

 

method SQLExecuteCommand(aSQLText: String): Integer

 

Integer SQLExecuteCommand(String aSQLText)

Parameters:

  • aSQLText: The text of the command to be executed.

SQLExecuteCommandEx

Executes the passed SQL statement as a command combining it with provided where statemt.

 

method SQLExecuteCommandEx(aSQLText: String; aDynamicWhereXML: String): Integer

 

Integer SQLExecuteCommandEx(String aSQLText, String aDynamicWhereXML)

Parameters:

  • aSQLText: The text statement in SQL format.
  • aDynamicWhereXML: The text with Dynamic Where condition in XML format.

SQLGetData

Executes the passed SQL statement and returns the record set as streamed data table.

 

method SQLGetData(aSQLText: String; aIncludeSchema: Boolean; aMaxRecords: Integer): array of SByte

 

SByte[] SQLGetData(String aSQLText, Boolean aIncludeSchema, Integer aMaxRecords)

Parameters:

  • aSQLText: The text of the select command to be executed.
  • aIncludeSchema: If set to true the response will contain schema.
  • aMaxRecords: Specifies the maximum number of records to retrieve. A value of -1 (default) will retrieve all records.

SQLGetDataEx

Executes the passed SQL statement and returns the record set as streamed data table. Supports Dynamic Where feature.

 

method SQLGetDataEx(aSQLText: String; aIncludeSchema: Boolean; aMaxRecords: Integer; aDynamicWhereXML: String): array of SByte

 

SByte[] SQLGetDataEx(String aSQLText, Boolean aIncludeSchema, Integer aMaxRecords, String aDynamicWhereXML)

Parameters:

  • aSQLText: The text of the select command to be executed.
  • aIncludeSchema: If set to true the response will contain schema.
  • aMaxRecords: Specifies the maximum number of records to retrieve. A value of -1 (default) will retrieve all records.
  • aDynamicWhereXML: The text with Dynamic Where condition in XML format.

UnregisterForDataChangeNotification

Unregisters a table that was registered by the RegisterForDataChangeNotification' method.

 

method UnregisterForDataChangeNotification(aTableName: String)

 

void UnregisterForDataChangeNotification(String aTableName)

Parameters:

  • aTableName: The name of the table that is to be unsibscribed from notifications.

UpdateData

Applies the encoded deltas from the provided stream and returns a stream that includes status information about the applied updates and possibly refreshed data.

 

method UpdateData(aDelta: array of SByte): array of SByte

 

SByte[] UpdateData(SByte[] aDelta)

Parameters:

  • aDelta: The delta list to process.

See Also