IDataAbstractService

Overview

The IDataAbstractService interface provides methods that clients can use to read data stored in a database, to apply updates, execute commands and more.

Location


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.

To enable the execution of commands from the client, set the AllowExecuteCommands property of your DataAbstractService to true and ensure that all published Commands in your Schema are safe for execution.

 

method ExecuteCommand(aCommandName: String; aParameterArray: array of DataParameter): Int32

 

Int32 ExecuteCommand(String aCommandName, DataParameter[] aParameterArray)

 

Function ExecuteCommand(aCommandName As String, aParameterArray As DataParameter()) As Int32

Parameters:

  • aCommandName: Command name in the Schema
  • aParameterArray: 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.

To enable the execution of commands from the client, set the AllowExecuteCommands property of your DataAbstractService to true and ensure that all published Commands in your Schema are safe for execution.

 

method ExecuteCommandEx(aCommandName: String; aInputParameters: array of DataParameter; out aOutputParameters: DataParameter): Int32

 

Int32 ExecuteCommandEx(String aCommandName, DataParameter[] aInputParameters, out DataParameter aOutputParameters)

 

Function ExecuteCommandEx(aCommandName As String, aInputParameters As DataParameter(), <OutAttribute> ByRef aOutputParameters As DataParameter) As Int32

Parameters:

  • aCommandName: Command name in the Schema
  • aInputParameters: List of input paramaters
  • aOutputParameters: List of output paramaters

GetCommandSchema

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

 

method GetCommandSchema(aCommandNameArray: array of String): String

 

String GetCommandSchema(String[] aCommandNameArray)

 

Function GetCommandSchema(aCommandNameArray As String()) As String

Parameters:

  • aCommandNameArray:

GetData

 

method GetData(aTableNameArray: array of String; aTableRequestInfoArray: array of TableRequestInfo): Binary

 

Binary GetData(String[] aTableNameArray, TableRequestInfo[] aTableRequestInfoArray)

 

Function GetData(aTableNameArray As String(), aTableRequestInfoArray As TableRequestInfo()) As Binary

Parameters:

  • aTableNameArray:
  • aTableRequestInfoArray:

GetDatasetScripts

Returns tables scripts in XML format.

 

method GetDatasetScripts(DatasetNames: String): String

 

String GetDatasetScripts(String DatasetNames)

 

Function GetDatasetScripts(DatasetNames As String) As String

Parameters:

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

GetSchema

Returns the schema referenced by the service to the calling client application, as XML.

 

method GetSchema(aFilter: String): String

 

String GetSchema(String aFilter)

 

Function GetSchema(aFilter As String) As String

Parameters:

  • aFilter:

GetTableSchema

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

 

method GetTableSchema(aTableNameArray: array of String): String

 

String GetTableSchema(String[] aTableNameArray)

 

Function GetTableSchema(aTableNameArray As String()) As String

Parameters:

  • aTableNameArray:

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)

 

Sub RegisterForDataChangeNotification(aTableName As String)

Parameters:

  • aTableName:

SQLExecuteCommand

Executes the passed SQL statement as a command. Note: Allowing clients to execute arbitrary SQL statements poses a security risk and should only be allowed with caution and when using proper authentication mechanisms to prevent anonymous users from making such calls.

The AllowExecuteCommands property is set to false by default to prevent SQL commands from being executed.

 

method SQLExecuteCommand(aSQLText: String): Int32

 

Int32 SQLExecuteCommand(String aSQLText)

 

Function SQLExecuteCommand(aSQLText As String) As Int32

Parameters:

  • aSQLText:

SQLExecuteCommandEx

 

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

 

Int32 SQLExecuteCommandEx(String aSQLText, String aDynamicWhereXML)

 

Function SQLExecuteCommandEx(aSQLText As String, aDynamicWhereXML As String) As Int32

Parameters:

  • aSQLText:
  • aDynamicWhereXML:

SQLGetData

Executes the passed SQL statement and returns the record set as streamed data table. Note: Allowing clients to execute arbitrary SQL statements poses a security risk and should only be allowed with caution and when using proper authentication mechanisms to prevent anonymous users from making such calls.

The AllowExecuteCommands property is set to false by default to prevent SQL commands from being executed.

 

method SQLGetData(aSQLText: String; aIncludeSchema: Boolean; aMaxRecords: Int32): Binary

 

Binary SQLGetData(String aSQLText, Boolean aIncludeSchema, Int32 aMaxRecords)

 

Function SQLGetData(aSQLText As String, aIncludeSchema As Boolean, aMaxRecords As Int32) As Binary

Parameters:

  • aSQLText:
  • aIncludeSchema:
  • aMaxRecords:

SQLGetDataEx

 

method SQLGetDataEx(aSQLText: String; aIncludeSchema: Boolean; aMaxRecords: Int32; aDynamicWhereXML: String): Binary

 

Binary SQLGetDataEx(String aSQLText, Boolean aIncludeSchema, Int32 aMaxRecords, String aDynamicWhereXML)

 

Function SQLGetDataEx(aSQLText As String, aIncludeSchema As Boolean, aMaxRecords As Int32, aDynamicWhereXML As String) As Binary

Parameters:

  • aSQLText:
  • aIncludeSchema:
  • aMaxRecords:
  • aDynamicWhereXML:

UnregisterForDataChangeNotification

Unregisters a table that was registered by the RegisterForDataChangeNotification method.

 

method UnregisterForDataChangeNotification(aTableName: String)

 

void UnregisterForDataChangeNotification(String aTableName)

 

Sub UnregisterForDataChangeNotification(aTableName As String)

Parameters:

  • aTableName:

UpdateData

Applies the deltas encoded in the passed stream to the database and returns a stream that includes status information about the applied updates and possibly refreshed data for the client.

This method provides the primary means of applying data updates from the client back to the server and is invoked when the Update method is called on a client-side RemoteDataAdapter component.

 

method UpdateData(aDelta: Binary): Binary

 

Binary UpdateData(Binary aDelta)

 

Function UpdateData(aDelta As Binary) As Binary

Parameters:

  • aDelta:

Implemented in