DataAbstractService_Proxy

Overview

The DataAbstractService_Proxy is used to talk to server's data service. It is used by RemoteDataAdapter as a default data proxy, though you can change it by calling RemoteDataAdapter.setDataService and providing your own implementation of IDataAbstractService.

Location

Implements

 

constructor

Creates an instance of an object.

 

constructor

 

DataAbstractService_Proxy()

constructor (Message, ClientChannel)

Creates an instance of a proxy service with the given Client Channel and Message objects.

 

constructor(aMessage: Message; aClientChannel: ClientChannel)

 

DataAbstractService_Proxy(Message aMessage, ClientChannel aClientChannel)

Parameters:

  • aMessage: A message to be used with the proxy class.
  • aClientChannel: A client channel to be used with the proxy class.

constructor (Message, ClientChannel, String)

Creates an instance of a proxy service with the given Client Channel and Message objects.

 

constructor(aMessage: Message; aClientChannel: ClientChannel; aOverrideInterfaceName: String)

 

DataAbstractService_Proxy(Message aMessage, ClientChannel aClientChannel, String aOverrideInterfaceName)

Parameters:

  • aMessage: A message to be used with the proxy class.
  • aClientChannel: A client channel to be used with the proxy class.
  • aOverrideInterfaceName: A service name to be used while talking to the remote service.

constructor (URI)

Creates an instance of proxy service and instantiates message and client channel relying on the given server URI.

 

constructor(aSchema: URI)

 

DataAbstractService_Proxy(URI aSchema)

Parameters:

  • aSchema: An url of the server.

constructor (URI, String)

Creates an instance of a proxy service and instantiates message and client channel relying on the given server URI.

 

constructor(aSchema: URI; aOverrideInterfaceName: String)

 

DataAbstractService_Proxy(URI aSchema, String aOverrideInterfaceName)

Parameters:

  • aSchema: An url of the server.
  • aOverrideInterfaceName: A service name to be used while talking to the remote service.

constructor (Message, ClientChannel)    (declared in Proxy)

 

constructor(message: Message; channel: ClientChannel)

 

DataAbstractService_Proxy(Message message, ClientChannel channel)

Parameters:

  • message:
  • channel:

constructor (Message, ClientChannel, String)    (declared in Proxy)

 

constructor(message: Message; channel: ClientChannel; interfaceName: String)

 

DataAbstractService_Proxy(Message message, ClientChannel channel, String interfaceName)

Parameters:

  • message:
  • channel:
  • interfaceName:

Charset    (declared in Proxy)

 

class property Charset: Charset read write;

 

class Charset Charset { __get; __set; }

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 server's DataAbstractService to true and ensure that all published Commands in your Schema are safe for execution.

 

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.

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

 

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 server's 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.

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

 

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

 

SByte[] GetData(StringArray aTableNameArray, TableRequestInfoArray aTableRequestInfoArray)

Parameters:

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

GetDatasetScripts

Returns scripts of server tables 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 referenced by the service to the calling client application, as XML.

 

method GetSchema(aFilter: String): String

 

String GetSchema(String aFilter)

Parameters:

  • aFilter: Reserved.

GetTableSchema

Returns the definitions of the server schema 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.

OverridenInterfaceName    (declared in Proxy)

 

property OverridenInterfaceName: String read write;

 

String OverridenInterfaceName { __get; __set; }

ProxyClientChannel    (declared in Proxy)

 

property ProxyClientChannel: ClientChannel read write;

 

ClientChannel ProxyClientChannel { __get; __set; }

ProxyMessage    (declared in Proxy)

 

property ProxyMessage: Message read write;

 

Message ProxyMessage { __get; __set; }

RegisterForDataChangeNotification  final

Registers a new table which will be refreshed automatically after other clients 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.

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 AllowExecuteCommand property on the server is set to false by default to prevent SQL commands from being executed.

 

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.

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 AllowExecuteCommand property on the server is set to false by default to prevent SQL commands from being executed.

 

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.

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 server's AllowExecuteCommands property is set false by default, to prevent SQL commands from being executed.

 

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 from the server. 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.

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 server's AllowExecuteCommands property is set false by default, to prevent SQL commands from being executed.

 

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 from the server. A value of -1 (default) will retrieve all records.
  • aDynamicWhereXML: The text with Dynamic Where condition in XML format.

UnregisterForDataChangeNotification  final

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 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 remote data adapter component.

 

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

 

SByte[] UpdateData(SByte[] aDelta)

Parameters:

  • aDelta: The delta list to process.

 

OverridenInterfaceName    (declared in Proxy)

 

property OverridenInterfaceName: String read write;

 

String OverridenInterfaceName { __get; __set; }

ProxyClientChannel    (declared in Proxy)

 

property ProxyClientChannel: ClientChannel read write;

 

ClientChannel ProxyClientChannel { __get; __set; }

ProxyMessage    (declared in Proxy)

 

property ProxyMessage: Message read write;

 

Message ProxyMessage { __get; __set; }

Charset    (declared in Proxy)

 

class property Charset: Charset read write;

 

class Charset Charset { __get; __set; }

 

constructor

Creates an instance of an object.

 

constructor

 

DataAbstractService_Proxy()

constructor (Message, ClientChannel)

Creates an instance of a proxy service with the given Client Channel and Message objects.

 

constructor(aMessage: Message; aClientChannel: ClientChannel)

 

DataAbstractService_Proxy(Message aMessage, ClientChannel aClientChannel)

Parameters:

  • aMessage: A message to be used with the proxy class.
  • aClientChannel: A client channel to be used with the proxy class.

constructor (Message, ClientChannel, String)

Creates an instance of a proxy service with the given Client Channel and Message objects.

 

constructor(aMessage: Message; aClientChannel: ClientChannel; aOverrideInterfaceName: String)

 

DataAbstractService_Proxy(Message aMessage, ClientChannel aClientChannel, String aOverrideInterfaceName)

Parameters:

  • aMessage: A message to be used with the proxy class.
  • aClientChannel: A client channel to be used with the proxy class.
  • aOverrideInterfaceName: A service name to be used while talking to the remote service.

constructor (URI)

Creates an instance of proxy service and instantiates message and client channel relying on the given server URI.

 

constructor(aSchema: URI)

 

DataAbstractService_Proxy(URI aSchema)

Parameters:

  • aSchema: An url of the server.

constructor (URI, String)

Creates an instance of a proxy service and instantiates message and client channel relying on the given server URI.

 

constructor(aSchema: URI; aOverrideInterfaceName: String)

 

DataAbstractService_Proxy(URI aSchema, String aOverrideInterfaceName)

Parameters:

  • aSchema: An url of the server.
  • aOverrideInterfaceName: A service name to be used while talking to the remote service.

constructor (Message, ClientChannel)    (declared in Proxy)

 

constructor(message: Message; channel: ClientChannel)

 

DataAbstractService_Proxy(Message message, ClientChannel channel)

Parameters:

  • message:
  • channel:

constructor (Message, ClientChannel, String)    (declared in Proxy)

 

constructor(message: Message; channel: ClientChannel; interfaceName: String)

 

DataAbstractService_Proxy(Message message, ClientChannel channel, String interfaceName)

Parameters:

  • message:
  • channel:
  • interfaceName:

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 server's DataAbstractService to true and ensure that all published Commands in your Schema are safe for execution.

 

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.

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

 

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 server's 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.

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

 

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

 

SByte[] GetData(StringArray aTableNameArray, TableRequestInfoArray aTableRequestInfoArray)

Parameters:

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

GetDatasetScripts

Returns scripts of server tables 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 referenced by the service to the calling client application, as XML.

 

method GetSchema(aFilter: String): String

 

String GetSchema(String aFilter)

Parameters:

  • aFilter: Reserved.

GetTableSchema

Returns the definitions of the server schema 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  final

Registers a new table which will be refreshed automatically after other clients 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.

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 AllowExecuteCommand property on the server is set to false by default to prevent SQL commands from being executed.

 

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.

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 AllowExecuteCommand property on the server is set to false by default to prevent SQL commands from being executed.

 

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.

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 server's AllowExecuteCommands property is set false by default, to prevent SQL commands from being executed.

 

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 from the server. 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.

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 server's AllowExecuteCommands property is set false by default, to prevent SQL commands from being executed.

 

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 from the server. A value of -1 (default) will retrieve all records.
  • aDynamicWhereXML: The text with Dynamic Where condition in XML format.

UnregisterForDataChangeNotification  final

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 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 remote data adapter component.

 

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

 

SByte[] UpdateData(SByte[] aDelta)

Parameters:

  • aDelta: The delta list to process.

See Also