DataAbstractService

Overview

This is the base class of all standard Data Abstract services.

It provides pre-defined methods that clients can use to read data stored in a database, to apply updates, execute commands and more.

A Data Abstract service references a Schema (see the ServiceSchemaName property) in which all the data elements it handles are defined. For instance, if you were to define a Customer Manager service, you would have it point to a schema where data tables such as Customers and Customer Details are defined. The same schema might contain commands that wrap specific insert or delete statements to update those tables too.

When a data abstract service is instantiated and the AcquireConnection property is set to true, the code of your methods can reference the Connection property which will already be initialized for you. The connection the service auto-creates is one of those defined in the server connection manager: you instruct the service to create a certain connection by setting the ConnectionName property.

Location


 

constructor

Creates a new instance of the DataAbstractService class.

 

constructor

 

DataAbstractService()

 

Sub New()

constructor (ISessionManager)

Creates a new instance of the DataAbstractService class and sets the provided ISessionManager instance as session provider.

This constructor should be used when the service instance should use session manager other than one globally registered in the server app.

 

constructor(sessionManager: ISessionManager)

 

DataAbstractService(ISessionManager sessionManager)

 

Sub New(sessionManager As ISessionManager)

Parameters:

  • sessionManager: Custom Session Manager instance

Creates a new instance of the DataAbstractService class and sets the provided session provider and event sink manager.

This constructor should be used when the service instance should use session manager or event sink manager other than ones globally registered in the server app.

 

constructor(sessionManager: ISessionManager; eventManager: IEventSinkManager)

 

DataAbstractService(ISessionManager sessionManager, IEventSinkManager eventManager)

 

Sub New(sessionManager As ISessionManager, eventManager As IEventSinkManager)

Parameters:

  • sessionManager: Custom Session Manager instance
  • eventManager: Custom Event manager instance

AcquireConnection

Toggles whether the service can automatically acquire a connection when it is activated. If set to true, the service will automatically obtain a connection to be used for data access whenever the service is activated and will automatically release the connection when the service is deactivated. The name specified in ConnectionName will determine what type of connection will be acquired; the Connection property will give access to the current connection.

 

property AcquireConnection: Boolean read write;

 

Boolean AcquireConnection { get; set; }

 

Property AcquireConnection() As Boolean

Activate    (declared in Service)

 

method Activate(clientId: Guid; enforceSessionCheck: Boolean; roles: nullable array of String)

 

void Activate(Guid clientId, Boolean enforceSessionCheck, String[]? roles)

 

Sub Activate(clientId As Guid, enforceSessionCheck As Boolean, roles As String()?)

Parameters:

  • clientId:
  • enforceSessionCheck:
  • roles:

AfterAcquireConnection

Occurs after the service has acquired a connection if the AcquireConnection property was set to true. Use this event if you need to perform custom actions on the new connection before the actual data access commences, such as modifying connection properties or running custom commands.

 

event AfterAcquireConnection: ConnectionOperationEventHandler;
delegate:  method AfterAcquireConnection(sender: DataAbstractService; e: ConnectionOperationEventArgs)

 

delegate ConnectionOperationEventHandler AfterAcquireConnection()
delegate:  void AfterAcquireConnection(DataAbstractService sender, ConnectionOperationEventArgs e)

 

Event AfterAcquireConnection As ConnectionOperationEventHandler
delegate:  Sub AfterAcquireConnection(sender As DataAbstractService, e As ConnectionOperationEventArgs)

AfterActivate    (declared in Service)

This event is raised after the service instance has been activated. This event can be used to perform additional service initialization tasks.

 

event AfterActivate: EventHandler<ServiceActivationEventArgs>;

 

delegate EventHandler<ServiceActivationEventArgs> AfterActivate()

 

Event AfterActivate As EventHandler<ServiceActivationEventArgs>

AfterAutoCreateBusinessProcessor

If the AutoCreateBusinessProcessors property is set to true, this event is fired after a business processor has been automatically created. You can use this event to make custom modifications to the created business processor, if needed.

 

event AfterAutoCreateBusinessProcessor: BusinessProcessorAutoCreatedEventHandler;
delegate:  method AfterAutoCreateBusinessProcessor(sender: DataAbstractService; e: BusinessProcessorAutoCreatedEventArgs)

 

delegate BusinessProcessorAutoCreatedEventHandler AfterAutoCreateBusinessProcessor()
delegate:  void AfterAutoCreateBusinessProcessor(DataAbstractService sender, BusinessProcessorAutoCreatedEventArgs e)

 

Event AfterAutoCreateBusinessProcessor As BusinessProcessorAutoCreatedEventHandler
delegate:  Sub AfterAutoCreateBusinessProcessor(sender As DataAbstractService, e As BusinessProcessorAutoCreatedEventArgs)

AfterBeginTransaction

Occurs after the service acquires a connection and begins a transaction. A transaction is automatically started when deltas are being processed by a call to UpdateData. The same transaction is either committed or rolled back at the end of the method call, depending on the delta having been processed successfully or not. You can use the connection's CurrentTransaction property to access the active transaction, for example to configure the transaction.

 

event AfterBeginTransaction: TransactionOperationEventHandler;
delegate:  method AfterBeginTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler AfterBeginTransaction()
delegate:  void AfterBeginTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event AfterBeginTransaction As TransactionOperationEventHandler
delegate:  Sub AfterBeginTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

AfterCommitTransaction

Occurs after the transaction acquired by the UpdateData method has been successfully committed.

 

event AfterCommitTransaction: TransactionOperationEventHandler;
delegate:  method AfterCommitTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler AfterCommitTransaction()
delegate:  void AfterCommitTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event AfterCommitTransaction As TransactionOperationEventHandler
delegate:  Sub AfterCommitTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

AfterDeactivate    (declared in Service)

This event is raised after the service instance has been deactivated. This event can be used to perform additional cleanup tasks.

 

event AfterDeactivate: EventHandler<ServiceActivationEventArgs>;

 

delegate EventHandler<ServiceActivationEventArgs> AfterDeactivate()

 

Event AfterDeactivate As EventHandler<ServiceActivationEventArgs>

AfterExecuteCommand

Occurs after a command was successfully executed using the ExecuteCommand and SqlExecuteCommand methods. You can use this event to inspect the result of the command before it is sent back to the client.

 

event AfterExecuteCommand: DataAbstractServiceExecuteCommandEventHandler;
delegate:  method AfterExecuteCommand(sender: DataAbstractService; e: DataAbstractServiceExecuteCommandEventArgs)

 

delegate DataAbstractServiceExecuteCommandEventHandler AfterExecuteCommand()
delegate:  void AfterExecuteCommand(DataAbstractService sender, DataAbstractServiceExecuteCommandEventArgs e)

 

Event AfterExecuteCommand As DataAbstractServiceExecuteCommandEventHandler
delegate:  Sub AfterExecuteCommand(sender As DataAbstractService, e As DataAbstractServiceExecuteCommandEventArgs)

AfterFindServiceSchema

Occurs the first time the property ServiceSchema is accessed and the schema has been loaded from the resource.

 

event AfterFindServiceSchema: ServiceSchemaOperationEventHandler;
delegate:  method AfterFindServiceSchema(sender: DataAbstractService; e: ServiceSchemaOperationEventArgs)

 

delegate ServiceSchemaOperationEventHandler AfterFindServiceSchema()
delegate:  void AfterFindServiceSchema(DataAbstractService sender, ServiceSchemaOperationEventArgs e)

 

Event AfterFindServiceSchema As ServiceSchemaOperationEventHandler
delegate:  Sub AfterFindServiceSchema(sender As DataAbstractService, e As ServiceSchemaOperationEventArgs)

AfterGetData

Occurs after the service has completed fetching data from the database as part of a call to GetData, and is about to send this data back to the client. You can use this event to perform custom actions after the update, such as updating internal statistics or running custom commands and queries on the database.

 

event AfterGetData: DataAbstractServiceGetDataEventHandler;
delegate:  method AfterGetData(sender: DataAbstractService; e: DataAbstractServiceGetDataEventArgs)

 

delegate DataAbstractServiceGetDataEventHandler AfterGetData()
delegate:  void AfterGetData(DataAbstractService sender, DataAbstractServiceGetDataEventArgs e)

 

Event AfterGetData As DataAbstractServiceGetDataEventHandler
delegate:  Sub AfterGetData(sender As DataAbstractService, e As DataAbstractServiceGetDataEventArgs)

AfterGetSchema

When a remote client requests the ServiceSchema using the remote GetSchema method, this event occurs after the schema has been retrieved, but before it is sent back to the client. Use this event to inspect or modify the XML.

 

event AfterGetSchema: DataAbstractServiceAfterGetSchemaEventHandler;
delegate:  method AfterGetSchema(sender: DataAbstractService; e: DataAbstractServiceAfterGetSchemaEventArgs)

 

delegate DataAbstractServiceAfterGetSchemaEventHandler AfterGetSchema()
delegate:  void AfterGetSchema(DataAbstractService sender, DataAbstractServiceAfterGetSchemaEventArgs e)

 

Event AfterGetSchema As DataAbstractServiceAfterGetSchemaEventHandler
delegate:  Sub AfterGetSchema(sender As DataAbstractService, e As DataAbstractServiceAfterGetSchemaEventArgs)

AfterProcessChange

 

event AfterProcessChange: EventHandler<DeltaChangeEventArgs>;

 

delegate EventHandler<DeltaChangeEventArgs> AfterProcessChange()

 

Event AfterProcessChange As EventHandler<DeltaChangeEventArgs>

AfterProcessDelta

 

event AfterProcessDelta: EventHandler<DeltaEventArgs>;

 

delegate EventHandler<DeltaEventArgs> AfterProcessDelta()

 

Event AfterProcessDelta As EventHandler<DeltaEventArgs>

AfterReleaseConnection

Occurs after the connection that was automatically acquired by the service was released when the service was deactivated.

 

event AfterReleaseConnection: ConnectionOperationEventHandler;
delegate:  method AfterReleaseConnection(sender: DataAbstractService; e: ConnectionOperationEventArgs)

 

delegate ConnectionOperationEventHandler AfterReleaseConnection()
delegate:  void AfterReleaseConnection(DataAbstractService sender, ConnectionOperationEventArgs e)

 

Event AfterReleaseConnection As ConnectionOperationEventHandler
delegate:  Sub AfterReleaseConnection(sender As DataAbstractService, e As ConnectionOperationEventArgs)

AfterRollBackTransaction

Occurs after the transaction that was started by the UpdateData method has been rolled back.

 

event AfterRollBackTransaction: TransactionOperationEventHandler;
delegate:  method AfterRollBackTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler AfterRollBackTransaction()
delegate:  void AfterRollBackTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event AfterRollBackTransaction As TransactionOperationEventHandler
delegate:  Sub AfterRollBackTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

AfterSqlGeneration

 

event AfterSqlGeneration: SqlGenerationEventHandler;
delegate:  method AfterSqlGeneration(sender: BusinessProcessor; e: SqlGenerationEventArgs)

 

delegate SqlGenerationEventHandler AfterSqlGeneration()
delegate:  void AfterSqlGeneration(BusinessProcessor sender, SqlGenerationEventArgs e)

 

Event AfterSqlGeneration As SqlGenerationEventHandler
delegate:  Sub AfterSqlGeneration(sender As BusinessProcessor, e As SqlGenerationEventArgs)

AfterUpdateData

Occurs after the service has completed applying updates to the database as part of a call to UpdateData. You can use this event to perform custom actions after the update, such as updating internal statistics or running custom commands and queries on the database.

 

event AfterUpdateData: DataAbstractServiceUpdateDataEventHandler;
delegate:  method AfterUpdateData(sender: DataAbstractService; e: DataAbstractServiceUpdateDataEventArgs)

 

delegate DataAbstractServiceUpdateDataEventHandler AfterUpdateData()
delegate:  void AfterUpdateData(DataAbstractService sender, DataAbstractServiceUpdateDataEventArgs e)

 

Event AfterUpdateData As DataAbstractServiceUpdateDataEventHandler
delegate:  Sub AfterUpdateData(sender As DataAbstractService, e As DataAbstractServiceUpdateDataEventArgs)

AllowAllFieldsInDynamicWhere

By security reasons, only fields that are present in table definition can be used in Dynamic Where expression.

This property allows to override default behavior and use any fields in such expressions. (Default value is False).

 

property AllowAllFieldsInDynamicWhere: Boolean read write;

 

Boolean AllowAllFieldsInDynamicWhere { get; set; }

 

Property AllowAllFieldsInDynamicWhere() As Boolean

AllowCustomSqlMacros

Allows clients to use custom variables of Macro Processor.

 

property AllowCustomSqlMacros: Boolean read write;

 

Boolean AllowCustomSqlMacros { get; set; }

 

Property AllowCustomSqlMacros() As Boolean

AllowDataAccess

Allows the clients to access Schema information from the published schema (true, default) or not(false).

 

property AllowDataAccess: Boolean read write;

 

Boolean AllowDataAccess { get; set; }

 

Property AllowDataAccess() As Boolean

AllowDynamicOrder

Allows clients to use Dynamic Order feature.

 

property AllowDynamicOrder: Boolean read write;

 

Boolean AllowDynamicOrder { get; set; }

 

Property AllowDynamicOrder() As Boolean

AllowDynamicSelect

Allows clients to use Dynamic Select feature.

 

property AllowDynamicSelect: Boolean read write;

 

Boolean AllowDynamicSelect { get; set; }

 

Property AllowDynamicSelect() As Boolean

AllowDynamicWhere

Allows clients to use Dynamic Where feature.

 

property AllowDynamicWhere: Boolean read write;

 

Boolean AllowDynamicWhere { get; set; }

 

Property AllowDynamicWhere() As Boolean

AllowExecuteCommands

Allows clients to execute commands that are published in the Schema (true) or not (false, default).

Set this property to true if you want to enable clients to manually execute commands defined in the ServiceSchema.

 

property AllowExecuteCommands: Boolean read write;

 

Boolean AllowExecuteCommands { get; set; }

 

Property AllowExecuteCommands() As Boolean

AllowExecuteDASQL

Allows clients to use DA SQL feature.

 

property AllowExecuteDASQL: Boolean read write;

 

Boolean AllowExecuteDASQL { get; set; }

 

Property AllowExecuteDASQL() As Boolean

AllowExecuteSQL

Gets or sets a flag indicating whether direct access to the underlying database is allowed.

When set to true allows execution of custom SQL queries as commands or for retrieving data bypassing the published server schema via the SQLGetData, SQLGetDataEx, SQLExecuteCommand and SQLExecuteCommandEx methods.

Note: Enabling this option opens a huge security risk as client applications can send any custom SQL text to the server for execution, including code that could potentially harm or even destroy the database.

The default value is false.

 

property AllowExecuteSQL: Boolean read write;

 

Boolean AllowExecuteSQL { get; set; }

 

Property AllowExecuteSQL() As Boolean

AllowHttpSchemaAccess

Using this property, you can allow or forbid access to the service schema by any client over HTTP protocol When AllowHttpSchemaAccess is set to True, the service schema could be retrieved via urls like http://myserver:8099/MyDAService

If you don't want to allow clients to get your service schema directly via HTTP (usually this can be a security issue), you need to set AllowHttpSchemaAccess to false and the server will raise a proper exception when somebody tries to get access to the service schema via HTTP.

You should understand the difference between AllowSchemaAccess and AllowHttpSchemaAccess properties. While AllowSchemaAccess property manages access to the Service Schema in general, AllowHttpSchemaAccess manages access to the Service Schema via HTTP only. That said you should have both these properties set to True for accessing service schema via HTTP.

Obviously this option is applicable only when the server is using http-based server channels.

 

property AllowHttpSchemaAccess: Boolean read write;

 

Boolean AllowHttpSchemaAccess { get; set; }

 

Property AllowHttpSchemaAccess() As Boolean

AllowSchemaAccess

Allows clients to access data from the published Schema (true, default) or not (false). Access to schema information from the server is often helpful while designing the client application since most clients do not need to refresh schema information from the server at runtime.

Although proper use of user authentication will restrict access, disabling this option for production servers prevents unnecessarily exposing the server schema to the outside world.

 

property AllowSchemaAccess: Boolean read write;

 

Boolean AllowSchemaAccess { get; set; }

 

Property AllowSchemaAccess() As Boolean

AllowUpdates

Allows clients to update data.

 

property AllowUpdates: Boolean read write;

 

Boolean AllowUpdates { get; set; }

 

Property AllowUpdates() As Boolean

AutoCreateBusinessProcessors

Instructs the service to create a business processor for each of the data tables that are being updated in an UpdateData call, if no explicit BusinessProcessor has been dropped at design time.

Set this property to true to allow automatic handling of updates to all data tables; set it to false to only allow data updates through manually configured BusinessProcessor components dropped onto your service.

 

property AutoCreateBusinessProcessors: Boolean read write;

 

Boolean AutoCreateBusinessProcessors { get; set; }

 

Property AutoCreateBusinessProcessors() As Boolean

BeforeAcquireConnection

Occurs before a connection is automatically acquired by the service. Use this event to control how connections are acquired if the AcquireConnection property is set to true, for example by dynamically modifying the ConnectionName property.

 

event BeforeAcquireConnection: BeforeAcquireConnectionEventHandler;
delegate:  method BeforeAcquireConnection(sender: DataAbstractService; e: BeforeAcquireConnectionEventArgs)

 

delegate BeforeAcquireConnectionEventHandler BeforeAcquireConnection()
delegate:  void BeforeAcquireConnection(DataAbstractService sender, BeforeAcquireConnectionEventArgs e)

 

Event BeforeAcquireConnection As BeforeAcquireConnectionEventHandler
delegate:  Sub BeforeAcquireConnection(sender As DataAbstractService, e As BeforeAcquireConnectionEventArgs)

BeforeActivate    (declared in Service)

This event is raised before the service instance will be activated. This event can be used to check additional service activation conditions.

 

event BeforeActivate: EventHandler<ServiceActivationEventArgs>;

 

delegate EventHandler<ServiceActivationEventArgs> BeforeActivate()

 

Event BeforeActivate As EventHandler<ServiceActivationEventArgs>

BeforeBeginTransaction

Occurs before a transaction has started during a call to the UpdateData method. Use this event if you need to perform custom configurations or actions on the Connection before the transaction is started.

 

event BeforeBeginTransaction: TransactionOperationEventHandler;
delegate:  method BeforeBeginTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler BeforeBeginTransaction()
delegate:  void BeforeBeginTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event BeforeBeginTransaction As TransactionOperationEventHandler
delegate:  Sub BeforeBeginTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

BeforeCommitTransaction

Occurs when a transaction is about to be committed at the end of a UpdateData method call. You can use the connection's CurrentTransaction property to access the active transaction before it gets committed, for example to configure the transaction or to perform additional database changes.

 

event BeforeCommitTransaction: TransactionOperationEventHandler;
delegate:  method BeforeCommitTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler BeforeCommitTransaction()
delegate:  void BeforeCommitTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event BeforeCommitTransaction As TransactionOperationEventHandler
delegate:  Sub BeforeCommitTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

BeforeDeactivate    (declared in Service)

This event is raised before the service instance will be deactivated. This event can be used to perform additional cleanup tasks.

 

event BeforeDeactivate: EventHandler<ServiceActivationEventArgs>;

 

delegate EventHandler<ServiceActivationEventArgs> BeforeDeactivate()

 

Event BeforeDeactivate As EventHandler<ServiceActivationEventArgs>

BeforeExecuteCommand

Occurs after a command was successfully executed using the ExecuteCommand and SqlExecuteCommand methods. You can use this event to inspect or modify the command before it is executed.

 

event BeforeExecuteCommand: DataAbstractServiceExecuteCommandEventHandler;
delegate:  method BeforeExecuteCommand(sender: DataAbstractService; e: DataAbstractServiceExecuteCommandEventArgs)

 

delegate DataAbstractServiceExecuteCommandEventHandler BeforeExecuteCommand()
delegate:  void BeforeExecuteCommand(DataAbstractService sender, DataAbstractServiceExecuteCommandEventArgs e)

 

Event BeforeExecuteCommand As DataAbstractServiceExecuteCommandEventHandler
delegate:  Sub BeforeExecuteCommand(sender As DataAbstractService, e As DataAbstractServiceExecuteCommandEventArgs)

BeforeExecutingGetDataReader

 

event BeforeExecutingGetDataReader: BeforeExecutingGetDataReaderEventHandler;
delegate:  method BeforeExecutingGetDataReader(sender: ServiceSchema; e: BeforeExecutingGetDataReaderEventArgs)

 

delegate BeforeExecutingGetDataReaderEventHandler BeforeExecutingGetDataReader()
delegate:  void BeforeExecutingGetDataReader(ServiceSchema sender, BeforeExecutingGetDataReaderEventArgs e)

 

Event BeforeExecutingGetDataReader As BeforeExecutingGetDataReaderEventHandler
delegate:  Sub BeforeExecutingGetDataReader(sender As ServiceSchema, e As BeforeExecutingGetDataReaderEventArgs)

BeforeFindServiceSchema

Occurs the first time the property ServiceSchema is accessed and the schema is about to be loaded from the resource. Use this event to manually adjust the ServiceSchemaName before the schema is located.

 

event BeforeFindServiceSchema: BeforeFindServiceSchemaEventHandler;
delegate:  method BeforeFindServiceSchema(sender: DataAbstractService; e: BeforeFindServiceSchemaEventArgs)

 

delegate BeforeFindServiceSchemaEventHandler BeforeFindServiceSchema()
delegate:  void BeforeFindServiceSchema(DataAbstractService sender, BeforeFindServiceSchemaEventArgs e)

 

Event BeforeFindServiceSchema As BeforeFindServiceSchemaEventHandler
delegate:  Sub BeforeFindServiceSchema(sender As DataAbstractService, e As BeforeFindServiceSchemaEventArgs)

BeforeGetData

You can use this event to perform custom actions after the update, such as updating internal statistics or running custom commands and queries on the database.

 

event BeforeGetData: DataAbstractServiceGetDataEventHandler;
delegate:  method BeforeGetData(sender: DataAbstractService; e: DataAbstractServiceGetDataEventArgs)

 

delegate DataAbstractServiceGetDataEventHandler BeforeGetData()
delegate:  void BeforeGetData(DataAbstractService sender, DataAbstractServiceGetDataEventArgs e)

 

Event BeforeGetData As DataAbstractServiceGetDataEventHandler
delegate:  Sub BeforeGetData(sender As DataAbstractService, e As DataAbstractServiceGetDataEventArgs)

BeforeGetSchema

When a remote client requests the ServiceSchema using the remote GetSchema method, this event occurs before the schema is retrieved. Use this event, for example, to allow/prevent Schema access based on session data, or to adjust the ServiceSchemaName before the schema is loaded.

 

event BeforeGetSchema: DataAbstractServiceGetSchemaEventHandler;
delegate:  method BeforeGetSchema(sender: DataAbstractService; e: DataAbstractServiceGetSchemaEventArgs)

 

delegate DataAbstractServiceGetSchemaEventHandler BeforeGetSchema()
delegate:  void BeforeGetSchema(DataAbstractService sender, DataAbstractServiceGetSchemaEventArgs e)

 

Event BeforeGetSchema As DataAbstractServiceGetSchemaEventHandler
delegate:  Sub BeforeGetSchema(sender As DataAbstractService, e As DataAbstractServiceGetSchemaEventArgs)

BeforeGetTableData

 

event BeforeGetTableData: BeforeGetTableDataEventHandler;
delegate:  method BeforeGetTableData(sender: BusinessProcessor; e: BeforeGetTableDataEventArgs)

 

delegate BeforeGetTableDataEventHandler BeforeGetTableData()
delegate:  void BeforeGetTableData(BusinessProcessor sender, BeforeGetTableDataEventArgs e)

 

Event BeforeGetTableData As BeforeGetTableDataEventHandler
delegate:  Sub BeforeGetTableData(sender As BusinessProcessor, e As BeforeGetTableDataEventArgs)

BeforeProcessChange

 

event BeforeProcessChange: EventHandler<DeltaChangeEventArgs>;

 

delegate EventHandler<DeltaChangeEventArgs> BeforeProcessChange()

 

Event BeforeProcessChange As EventHandler<DeltaChangeEventArgs>

BeforeProcessDelta

 

event BeforeProcessDelta: EventHandler<DeltaEventArgs>;

 

delegate EventHandler<DeltaEventArgs> BeforeProcessDelta()

 

Event BeforeProcessDelta As EventHandler<DeltaEventArgs>

BeforeReleaseConnection

Occurs before the connection that was automatically acquired by the service is released and the service is being deactivated. Use this event if you need to perform custom actions on the connection after the actual data access has completed, for example running custom commands or logging access statistics.

 

event BeforeReleaseConnection: ConnectionOperationEventHandler;
delegate:  method BeforeReleaseConnection(sender: DataAbstractService; e: ConnectionOperationEventArgs)

 

delegate ConnectionOperationEventHandler BeforeReleaseConnection()
delegate:  void BeforeReleaseConnection(DataAbstractService sender, ConnectionOperationEventArgs e)

 

Event BeforeReleaseConnection As ConnectionOperationEventHandler
delegate:  Sub BeforeReleaseConnection(sender As DataAbstractService, e As ConnectionOperationEventArgs)

BeforeRollBackTransaction

Occurs before the transaction that was begun by the UpdateData method is about to be rolled back. You can use the connection's CurrentTransaction property to access the active transaction before it gets rolled back, for example to configure the transaction or to perform additional database changes.

 

event BeforeRollBackTransaction: TransactionOperationEventHandler;
delegate:  method BeforeRollBackTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler BeforeRollBackTransaction()
delegate:  void BeforeRollBackTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event BeforeRollBackTransaction As TransactionOperationEventHandler
delegate:  Sub BeforeRollBackTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

BeforeUpdateData

Occurs before the service starts applying updates to the database as part of a call to UpdateData. You can use this event to perform custom actions before the update, such as updating internal statistics or running custom commands and queries on the database.

 

event BeforeUpdateData: DataAbstractServiceUpdateDataEventHandler;
delegate:  method BeforeUpdateData(sender: DataAbstractService; e: DataAbstractServiceUpdateDataEventArgs)

 

delegate DataAbstractServiceUpdateDataEventHandler BeforeUpdateData()
delegate:  void BeforeUpdateData(DataAbstractService sender, DataAbstractServiceUpdateDataEventArgs e)

 

Event BeforeUpdateData As DataAbstractServiceUpdateDataEventHandler
delegate:  Sub BeforeUpdateData(sender As DataAbstractService, e As DataAbstractServiceUpdateDataEventArgs)

BeginTransaction  protected

 

method BeginTransaction(var connection: IAbstractConnection): Int32

 

Int32 BeginTransaction(ref IAbstractConnection connection)

 

Function BeginTransaction(ByRef connection As IAbstractConnection) As Int32

Parameters:

  • connection:

BuildParameters  protected

 

class method BuildParameters(aReq: SimpleRequestInfo): array of DataParameter

 

static DataParameter[] BuildParameters(SimpleRequestInfo aReq)

 

Shared Function BuildParameters(aReq As SimpleRequestInfo) As DataParameter()

Parameters:

  • aReq:

BusinessProcessors

This property lists all the business processors the service owns. This list includes both automatically created business processors and those explicitly dropped on the service at design time.

 

property BusinessProcessors: IDictionary<String, BusinessProcessor> read;

 

IDictionary<String, BusinessProcessor> BusinessProcessors { get; }

 

ReadOnly Property BusinessProcessors() As IDictionary<String, BusinessProcessor>

CanBeDisposed    (declared in Service)

Get a flag indicating whether the current service instance can be disposed after servicing the request.

 

property CanBeDisposed: Boolean read;

 

Boolean CanBeDisposed { get; }

 

ReadOnly Property CanBeDisposed() As Boolean

CheckConnection  protected

 

method CheckConnection

 

void CheckConnection()

 

Sub CheckConnection()

CommitTransaction  protected

 

method CommitTransaction(connection: IAbstractConnection)

 

void CommitTransaction(IAbstractConnection connection)

 

Sub CommitTransaction(connection As IAbstractConnection)

Parameters:

  • connection:

Connection

Lets you access the connection that is automatically created by the service if the property AcquireConnection is set to true.

 

property Connection: IAbstractConnection read write;

 

IAbstractConnection Connection { get; set; }

 

Property Connection() As IAbstractConnection

ConnectionName

Determines the name of the connection to acquire whenever AcquireConnection is true. If the string is empty, the service will acquire the connection marked as default.

 

property ConnectionName: String read write;

 

String ConnectionName { get; set; }

 

Property ConnectionName() As String

ConnectionTimeout

 

property ConnectionTimeout: Int32 read write;

 

Int32 ConnectionTimeout { get; set; }

 

Property ConnectionTimeout() As Int32

CustomMacroHandler  protected

 

method CustomMacroHandler(name: String; originalName: String; var value: String): Boolean

 

Boolean CustomMacroHandler(String name, String originalName, ref String value)

 

Function CustomMacroHandler(name As String, originalName As String, ByRef value As String) As Boolean

Parameters:

  • name:
  • originalName:
  • value:

DASqlProcessor

 

property DASqlProcessor: DASqlProcessor read write;

 

DASqlProcessor DASqlProcessor { get; set; }

 

Property DASqlProcessor() As DASqlProcessor

Deactivate    (declared in Service)

Deactivates the service instance.

This method raises the Service and Service events and releases the service session.

 

method Deactivate(clientId: Guid)

 

void Deactivate(Guid clientId)

 

Sub Deactivate(clientId As Guid)

Parameters:

  • clientId: Session Id

DeserializeDeltas  protected

Deserializes the provided Binary stream as a Deltas collection.

This method uses the ServiceDataStreamer data streamer to perform the deserialization task.

 

method DeserializeDeltas(source: Binary): RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>

 

RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta> DeserializeDeltas(Binary source)

 

Function DeserializeDeltas(source As Binary) As RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>

Parameters:

  • source: Source data stream containing serialized Deltas collection

DestroySession  protected    (declared in Service)

Destroys and disposes the current session.

This method is widely used in the login services to destroy the user session after logout or in case the login attempt was not successful.

 

method DestroySession

 

void DestroySession()

 

Sub DestroySession()

Dispose  protected

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

DropConnection  protected

Drops the provided connection.

 

method DropConnection(connection: IAbstractConnection)

 

void DropConnection(IAbstractConnection connection)

 

Sub DropConnection(connection As IAbstractConnection)

Parameters:

  • connection: Connection to drop

EventSinkManager  protected    (declared in Service)

Provides access to the event sink manager that should be used by the service methods.

 

property EventSinkManager: IEventSinkManager read;

 

IEventSinkManager EventSinkManager { get; }

 

ReadOnly Property EventSinkManager() As IEventSinkManager

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(commandName: String; parameters: array of DataParameter): Int32

 

Int32 ExecuteCommand(String commandName, DataParameter[] parameters)

 

Function ExecuteCommand(commandName As String, parameters As DataParameter()) As Int32

Parameters:

  • commandName:
  • parameters:

ExecuteCommandEx

 

method ExecuteCommandEx(commandName: String; inputParameters: array of DataParameter; out outputParameters: array of DataParameter): Int32

 

Int32 ExecuteCommandEx(String commandName, DataParameter[] inputParameters, out DataParameter[] outputParameters)

 

Function ExecuteCommandEx(commandName As String, inputParameters As DataParameter(), <OutAttribute> ByRef outputParameters As DataParameter()) As Int32

Parameters:

  • commandName:
  • inputParameters:
  • outputParameters:

GetBusinessProcessor  protected

 

method GetBusinessProcessor(tableName: String; createIfNeeded: Boolean): BusinessProcessor

 

BusinessProcessor GetBusinessProcessor(String tableName, Boolean createIfNeeded)

 

Function GetBusinessProcessor(tableName As String, createIfNeeded As Boolean) As BusinessProcessor

Parameters:

  • tableName:
  • createIfNeeded:

GetCommandSchema

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

 

method GetCommandSchema(commandNames: array of String): String

 

String GetCommandSchema(String[] commandNames)

 

Function GetCommandSchema(commandNames As String()) As String

Parameters:

  • commandNames:

GetConnection  protected

 

method GetConnection: IAbstractConnection

 

IAbstractConnection GetConnection()

 

Function GetConnection() As IAbstractConnection

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 or 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(tableNames: array of String; requestInfo: array of TableRequestInfo): Binary

 

Binary GetData(String[] tableNames, TableRequestInfo[] requestInfo)

 

Function GetData(tableNames As String(), requestInfo As TableRequestInfo()) As Binary

Parameters:

  • tableNames:
  • requestInfo:

GetDatasetScripts

 

method GetDatasetScripts(tableNames: String): String

 

String GetDatasetScripts(String tableNames)

 

Function GetDatasetScripts(tableNames As String) As String

Parameters:

  • tableNames:

GetEventSink (Type): IROEventSink    (declared in Service)

Obtains an event sink proxy for the specified interface.

 

method GetEventSink(eventSink: Type): IROEventSink

 

IROEventSink GetEventSink(Type eventSink)

 

Function GetEventSink(eventSink As Type) As IROEventSink

Parameters:

  • eventSink: Event sink type

GetEventSink (Type, IEventTargets): IROEventSink    (declared in Service)

Obtains an event sink proxy for the specified interface. This method allows to manage the event recipients.

 

method GetEventSink(eventSink: Type; eventTargets: IEventTargets): IROEventSink

 

IROEventSink GetEventSink(Type eventSink, IEventTargets eventTargets)

 

Function GetEventSink(eventSink As Type, eventTargets As IEventTargets) As IROEventSink

Parameters:

  • eventSink: Event sink type
  • eventTargets: Event recepients

GetEventSink (Type, array of Guid): IROEventSink    (declared in Service)

Obtains an event sink proxy for the specified interface. This method allows to set the event recipients.

 

method GetEventSink(eventSink: Type; recipients: array of Guid): IROEventSink

 

IROEventSink GetEventSink(Type eventSink, Guid[] recipients)

 

Function GetEventSink(eventSink As Type, recipients As Guid()) As IROEventSink

Parameters:

  • eventSink: Event sink type
  • recipients: Event recipients

GetEventSink<T>    (declared in Service)

 

method GetEventSink<T>: T

 

T GetEventSink<T>()

 

Function GetEventSink<T>() As T

GetEventSink<T> (IEventTargets): T    (declared in Service)

 

method GetEventSink<T>(eventTargets: IEventTargets): T

 

T GetEventSink<T>(IEventTargets eventTargets)

 

Function GetEventSink<T>(eventTargets As IEventTargets) As T

Parameters:

  • eventTargets:

GetEventSink<T> (array of Guid): T    (declared in Service)

 

method GetEventSink<T>(recipients: array of Guid): T

 

T GetEventSink<T>(Guid[] recipients)

 

Function GetEventSink<T>(recipients As Guid()) As T

Parameters:

  • recipients:

GetSchema

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

 

method GetSchema(filter: String): String

 

String GetSchema(String filter)

 

Function GetSchema(filter As String) As String

Parameters:

  • filter:

GetScriptContext  protected

 

method GetScriptContext: IServerScriptContext

 

IServerScriptContext GetScriptContext()

 

Function GetScriptContext() As IServerScriptContext

GetScriptDebugger  protected

 

method GetScriptDebugger: IScriptDebugger

 

IScriptDebugger GetScriptDebugger()

 

Function GetScriptDebugger() As IScriptDebugger

GetSession  protected    (declared in Service)

Gets the service session. Unlike the Service property this method returns null instead of throwing an exception in case the Service is not set.

 

method GetSession: ISession

 

ISession GetSession()

 

Function GetSession() As ISession

GetTableSchema

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

 

method GetTableSchema(tableNames: array of String): String

 

String GetTableSchema(String[] tableNames)

 

Function GetTableSchema(tableNames As String()) As String

Parameters:

  • tableNames:

HasSession    (declared in Service)

Gets a flag indicating whether a session is accessible (ie Service is set and the session itself exists for the current remote client)

 

property HasSession: Boolean read;

 

Boolean HasSession { get; }

 

ReadOnly Property HasSession() As Boolean

InitializeScriptProvider  protected

 

method InitializeScriptProvider

 

void InitializeScriptProvider()

 

Sub InitializeScriptProvider()

InitializeServiceSchema  protected

 

method InitializeServiceSchema

 

void InitializeServiceSchema()

 

Sub InitializeServiceSchema()

InitializeServiceSchemaAndScriptProvider

 

method InitializeServiceSchemaAndScriptProvider(ignoreCache: Boolean)

 

void InitializeServiceSchemaAndScriptProvider(Boolean ignoreCache)

 

Sub InitializeServiceSchemaAndScriptProvider(ignoreCache As Boolean)

Parameters:

  • ignoreCache:

IsActive    (declared in Service)

 

property IsActive: Boolean read;

 

Boolean IsActive { get; }

 

ReadOnly Property IsActive() As Boolean

ProcessAllDeltas

Determines if the service should also process the deltas for which update rules have not been defined.

 

property ProcessAllDeltas: Boolean read write;

 

Boolean ProcessAllDeltas { get; set; }

 

Property ProcessAllDeltas() As Boolean

ProcessDelta  protected

 

method ProcessDelta(delta: Delta; allowInsert: Boolean; allowUpdate: Boolean; allowDelete: Boolean; detailDeltas: RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>)

 

void ProcessDelta(Delta delta, Boolean allowInsert, Boolean allowUpdate, Boolean allowDelete, RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta> detailDeltas)

 

Sub ProcessDelta(delta As Delta, allowInsert As Boolean, allowUpdate As Boolean, allowDelete As Boolean, detailDeltas As RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>)

Parameters:

  • delta:
  • allowInsert:
  • allowUpdate:
  • allowDelete:
  • detailDeltas:

ProcessError

 

event ProcessError: EventHandler<DeltaChangeErrorEventArgs>;

 

delegate EventHandler<DeltaChangeErrorEventArgs> ProcessError()

 

Event ProcessError As EventHandler<DeltaChangeErrorEventArgs>

RegisterAllBusinessProcessors  protected

 

method RegisterAllBusinessProcessors

 

void RegisterAllBusinessProcessors()

 

Sub RegisterAllBusinessProcessors()

RegisterBusinessProcessor

 

method RegisterBusinessProcessor(processor: BusinessProcessor)

 

void RegisterBusinessProcessor(BusinessProcessor processor)

 

Sub RegisterBusinessProcessor(processor As BusinessProcessor)

Parameters:

  • processor:

RegisterForDataChangeNotification

 

method RegisterForDataChangeNotification(tableName: String)

 

void RegisterForDataChangeNotification(String tableName)

 

Sub RegisterForDataChangeNotification(tableName As String)

Parameters:

  • tableName:

ReleaseConnection  protected

Releases provided connection back to the connection pool provided by the ConnectionManager.

 

method ReleaseConnection(connection: IAbstractConnection)

 

void ReleaseConnection(IAbstractConnection connection)

 

Sub ReleaseConnection(connection As IAbstractConnection)

Parameters:

  • connection: Connection to release

ReloadScript

 

method ReloadScript

 

void ReloadScript()

 

Sub ReloadScript()

RequireSession    (declared in Service)

Gets or sets a flag ingicating wheter accessing this service methods remotely requres an existing session.

 

property RequireSession: Boolean read write;

 

Boolean RequireSession { get; set; }

 

Property RequireSession() As Boolean

Roles    (declared in Service)

 

property Roles: array of String read write;

 

String[] Roles { get; set; }

 

Property Roles() As String()

RollbackTransaction  protected

 

method RollbackTransaction(connection: IAbstractConnection)

 

void RollbackTransaction(IAbstractConnection connection)

 

Sub RollbackTransaction(connection As IAbstractConnection)

Parameters:

  • connection:

RollbackUpdatesOnError

 

property RollbackUpdatesOnError: Boolean read write;

 

Boolean RollbackUpdatesOnError { get; set; }

 

Property RollbackUpdatesOnError() As Boolean

ScriptProvider

 

property ScriptProvider: IScriptProvider read write;

 

IScriptProvider ScriptProvider { get; set; }

 

Property ScriptProvider() As IScriptProvider

SerializeDeltas  protected

Serializes the provided Deltas collection into a Binary stream.

This method uses the ServiceDataStreamer data streamer to perform the serialization task.

 

method SerializeDeltas(deltas: RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>): Binary

 

Binary SerializeDeltas(RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta> deltas)

 

Function SerializeDeltas(deltas As RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>) As Binary

Parameters:

  • deltas: Source Deltas collection

ServerChannel    (declared in Service)

Gets a IServerChannelInfo instance providing information about the server channel used to call the service method remotely.

 

property ServerChannel: IServerChannelInfo read;

 

IServerChannelInfo ServerChannel { get; }

 

ReadOnly Property ServerChannel() As IServerChannelInfo

ServeSchema

 

property ServeSchema: Boolean read write;

 

Boolean ServeSchema { get; set; }

 

Property ServeSchema() As Boolean

ServiceActivationException    (declared in Service)

 

event ServiceActivationException: EventHandler<ServiceActivationExceptionEventArgs>;

 

delegate EventHandler<ServiceActivationExceptionEventArgs> ServiceActivationException()

 

Event ServiceActivationException As EventHandler<ServiceActivationExceptionEventArgs>

ServiceDataStreamer

Identifies the DataStreamer associated with the service. Data streamers are used to encode the data streams used by the GetData and UpdateData methods.

 

property ServiceDataStreamer: DataStreamer read write;

 

DataStreamer ServiceDataStreamer { get; set; }

 

Property ServiceDataStreamer() As DataStreamer

ServiceMethodException    (declared in Service)

 

event ServiceMethodException: EventHandler<ServiceMethodExceptionEventArgs>;

 

delegate EventHandler<ServiceMethodExceptionEventArgs> ServiceMethodException()

 

Event ServiceMethodException As EventHandler<ServiceMethodExceptionEventArgs>

ServiceSchema

Returns an instance of a schema that has loaded the schema file identified by the ServiceSchemaName.

 

property ServiceSchema: ServiceSchema read;

 

ServiceSchema ServiceSchema { get; }

 

ReadOnly Property ServiceSchema() As ServiceSchema

ServiceSchemaName

Identifies the name of the Schema resource the service has to load whenever the ServiceSchema property is accessed.

 

property ServiceSchemaName: String read write;

 

String ServiceSchemaName { get; set; }

 

Property ServiceSchemaName() As String

ServiceValidateRoles    (declared in Service)

Validates the service roles. This method is used by the service invoker methods to validate the server access roles.

See the IRolesAwareService interface description for more details.

 

method ServiceValidateRoles(requiredRoles: array of String)

 

void ServiceValidateRoles(String[] requiredRoles)

 

Sub ServiceValidateRoles(requiredRoles As String())

Parameters:

  • requiredRoles: Required service roles

Session    (declared in Service)

Provides access to the Session for the current remote client. In case when session doesn't exist for the current client yet, a new session will be created when the Session property is accessed (but not before).

 

property Session: ISession read write;

 

ISession Session { get; set; }

 

Property Session() As ISession

SessionID    (declared in Service)

Gets the Session ID (aka remote client Id) for the request that is currently being executed.

 

property SessionID: Guid read;

 

Guid SessionID { get; }

 

ReadOnly Property SessionID() As Guid

SessionManager  protected    (declared in Service)

Provides access to the session manager that is used by the service.

 

property SessionManager: ISessionManager read;

 

ISessionManager SessionManager { get; }

 

ReadOnly Property SessionManager() As ISessionManager

SetupDASqlProcessor  protected

 

method SetupDASqlProcessor

 

void SetupDASqlProcessor()

 

Sub SetupDASqlProcessor()

SimpleGetData

 

method SimpleGetData(requestInfo: array of SimpleRequestInfo): array of SimpleDataResult

 

SimpleDataResult[] SimpleGetData(SimpleRequestInfo[] requestInfo)

 

Function SimpleGetData(requestInfo As SimpleRequestInfo()) As SimpleDataResult()

Parameters:

  • requestInfo:

SimpleUpdateData

 

method SimpleUpdateData(delta: array of SimpleDelta): array of SimpleDelta

 

SimpleDelta[] SimpleUpdateData(SimpleDelta[] delta)

 

Function SimpleUpdateData(delta As SimpleDelta()) As SimpleDelta()

Parameters:

  • delta:

SQLExecuteCommand

Executes the provided SQL statement AS IS at the underlying database server bypassing any Schema validation procedures on it.

Note: Allowing clients to execute arbitrary SQL statements is a high security risk and should only be allowed with caution.

The AllowExecuteSQL property is set to false by default, preventing direct SQL commands from being executed.

 

method SQLExecuteCommand(sql: String): Int32

 

Int32 SQLExecuteCommand(String sql)

 

Function SQLExecuteCommand(sql As String) As Int32

Parameters:

  • sql: SQL statement

SQLExecuteCommandEx

Executes the provided SQL statement AS IS at the underlying database server bypassing any Schema validation procedures on it.

Note: Allowing clients to execute arbitrary SQL statements is a high security risk and should only be allowed with caution.

The AllowExecuteSQL property is set to false by default, preventing direct SQL commands from being executed.

 

method SQLExecuteCommandEx(sql: String; dynamicWhere: String): Int32

 

Int32 SQLExecuteCommandEx(String sql, String dynamicWhere)

 

Function SQLExecuteCommandEx(sql As String, dynamicWhere As String) As Int32

Parameters:

  • sql: SQL statement
  • dynamicWhere: DynamicWhere condition that will be applied to the command execution result

SQLGetData

Executes the provided SQL statement AS IS at the underlying database server bypassing any Schema validation procedures on it and returns its serialized result to the caller.

Note: Allowing clients to execute arbitrary SQL statements is a high security risk and should only be allowed with caution.

The AllowExecuteSQL property is set to false by default, preventing direct SQL commands from being executed.

 

method SQLGetData(sql: String; includeSchema: Boolean; maxRecords: Int32): Binary

 

Binary SQLGetData(String sql, Boolean includeSchema, Int32 maxRecords)

 

Function SQLGetData(sql As String, includeSchema As Boolean, maxRecords As Int32) As Binary

Parameters:

  • sql: SQL statement
  • includeSchema: Include Schema of the resulting data ito the output data stream
  • maxRecords: Maximum numer of records that will be returned in the data stream; -1 means that no limits are applied

SQLGetDataEx

Executes the provided SQL statement AS IS at the underlying database server bypassing any Schema validation procedures on it and returns its serialized result to the caller.

Note: Allowing clients to execute arbitrary SQL statements is a high security risk and should only be allowed with caution.

The AllowExecuteSQL property is set to false by default, preventing direct SQL commands from being executed.

 

method SQLGetDataEx(sql: String; includeSchema: Boolean; maxRecords: Int32; dynamicWhere: String): Binary

 

Binary SQLGetDataEx(String sql, Boolean includeSchema, Int32 maxRecords, String dynamicWhere)

 

Function SQLGetDataEx(sql As String, includeSchema As Boolean, maxRecords As Int32, dynamicWhere As String) As Binary

Parameters:

  • sql: SQL statement
  • includeSchema: Include Schema of the resulting data ito the output data stream
  • maxRecords: Maximum numer of records that will be returned in the data stream; -1 means that no limits are applied
  • dynamicWhere: DynamicWhere condition that will be applied to the statement execution result

SubscribeClientEventSink    (declared in Service)

This method registers the current client as receiver of the provided events type.

 

method SubscribeClientEventSink(eventSink: Type)

 

void SubscribeClientEventSink(Type eventSink)

 

Sub SubscribeClientEventSink(eventSink As Type)

Parameters:

  • eventSink: Event sink type

TriggerAfterAcquireConnection  protected

 

method TriggerAfterAcquireConnection(e: ConnectionOperationEventArgs)

 

void TriggerAfterAcquireConnection(ConnectionOperationEventArgs e)

 

Sub TriggerAfterAcquireConnection(e As ConnectionOperationEventArgs)

Parameters:

  • e:

TriggerAfterActivate  protected    (declared in Service)

Raises the Service event.

 

method TriggerAfterActivate(sessionId: Guid)

 

void TriggerAfterActivate(Guid sessionId)

 

Sub TriggerAfterActivate(sessionId As Guid)

Parameters:

  • sessionId: Session Id

TriggerAfterAutoCreateBusinessProcessor  protected

 

method TriggerAfterAutoCreateBusinessProcessor(e: BusinessProcessorAutoCreatedEventArgs)

 

void TriggerAfterAutoCreateBusinessProcessor(BusinessProcessorAutoCreatedEventArgs e)

 

Sub TriggerAfterAutoCreateBusinessProcessor(e As BusinessProcessorAutoCreatedEventArgs)

Parameters:

  • e:

TriggerAfterBeginTransaction  protected

 

method TriggerAfterBeginTransaction(e: TransactionOperationEventArgs)

 

void TriggerAfterBeginTransaction(TransactionOperationEventArgs e)

 

Sub TriggerAfterBeginTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerAfterCommitTransaction  protected

 

method TriggerAfterCommitTransaction(e: TransactionOperationEventArgs)

 

void TriggerAfterCommitTransaction(TransactionOperationEventArgs e)

 

Sub TriggerAfterCommitTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerAfterDeactivate  protected    (declared in Service)

Raises the Service event.

 

method TriggerAfterDeactivate(sessionId: Guid)

 

void TriggerAfterDeactivate(Guid sessionId)

 

Sub TriggerAfterDeactivate(sessionId As Guid)

Parameters:

  • sessionId: Session Id

TriggerAfterExecuteCommand (DataAbstractServiceExecuteCommandEventArgs)  protected

 

method TriggerAfterExecuteCommand(e: DataAbstractServiceExecuteCommandEventArgs)

 

void TriggerAfterExecuteCommand(DataAbstractServiceExecuteCommandEventArgs e)

 

Sub TriggerAfterExecuteCommand(e As DataAbstractServiceExecuteCommandEventArgs)

Parameters:

  • e:

TriggerAfterExecuteCommand (ExecuteCommandArgs)  protected

 

method TriggerAfterExecuteCommand(e: ExecuteCommandArgs)

 

void TriggerAfterExecuteCommand(ExecuteCommandArgs e)

 

Sub TriggerAfterExecuteCommand(e As ExecuteCommandArgs)

Parameters:

  • e:

TriggerAfterFindServiceSchema  protected

 

method TriggerAfterFindServiceSchema(e: ServiceSchemaOperationEventArgs)

 

void TriggerAfterFindServiceSchema(ServiceSchemaOperationEventArgs e)

 

Sub TriggerAfterFindServiceSchema(e As ServiceSchemaOperationEventArgs)

Parameters:

  • e:

TriggerAfterGetData  protected

 

method TriggerAfterGetData(e: DataAbstractServiceGetDataEventArgs)

 

void TriggerAfterGetData(DataAbstractServiceGetDataEventArgs e)

 

Sub TriggerAfterGetData(e As DataAbstractServiceGetDataEventArgs)

Parameters:

  • e:

TriggerAfterGetSchema  protected

 

method TriggerAfterGetSchema(e: DataAbstractServiceAfterGetSchemaEventArgs)

 

void TriggerAfterGetSchema(DataAbstractServiceAfterGetSchemaEventArgs e)

 

Sub TriggerAfterGetSchema(e As DataAbstractServiceAfterGetSchemaEventArgs)

Parameters:

  • e:

TriggerAfterProcessChange  protected

 

method TriggerAfterProcessChange(e: DeltaChangeEventArgs)

 

void TriggerAfterProcessChange(DeltaChangeEventArgs e)

 

Sub TriggerAfterProcessChange(e As DeltaChangeEventArgs)

Parameters:

  • e:

TriggerAfterProcessDelta  protected

 

method TriggerAfterProcessDelta(e: DeltaEventArgs)

 

void TriggerAfterProcessDelta(DeltaEventArgs e)

 

Sub TriggerAfterProcessDelta(e As DeltaEventArgs)

Parameters:

  • e:

TriggerAfterReleaseConnection  protected

 

method TriggerAfterReleaseConnection(e: ConnectionOperationEventArgs)

 

void TriggerAfterReleaseConnection(ConnectionOperationEventArgs e)

 

Sub TriggerAfterReleaseConnection(e As ConnectionOperationEventArgs)

Parameters:

  • e:

TriggerAfterRollBackTransaction  protected

 

method TriggerAfterRollBackTransaction(e: TransactionOperationEventArgs)

 

void TriggerAfterRollBackTransaction(TransactionOperationEventArgs e)

 

Sub TriggerAfterRollBackTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerAfterSqlGeneration  protected

 

method TriggerAfterSqlGeneration(e: SqlGenerationEventArgs)

 

void TriggerAfterSqlGeneration(SqlGenerationEventArgs e)

 

Sub TriggerAfterSqlGeneration(e As SqlGenerationEventArgs)

Parameters:

  • e:

TriggerAfterUpdateData  protected

 

method TriggerAfterUpdateData(e: DataAbstractServiceUpdateDataEventArgs)

 

void TriggerAfterUpdateData(DataAbstractServiceUpdateDataEventArgs e)

 

Sub TriggerAfterUpdateData(e As DataAbstractServiceUpdateDataEventArgs)

Parameters:

  • e:

TriggerBeforeAcquireConnection  protected

 

method TriggerBeforeAcquireConnection(e: BeforeAcquireConnectionEventArgs)

 

void TriggerBeforeAcquireConnection(BeforeAcquireConnectionEventArgs e)

 

Sub TriggerBeforeAcquireConnection(e As BeforeAcquireConnectionEventArgs)

Parameters:

  • e:

TriggerBeforeActivate  protected    (declared in Service)

Raises the Service event.

 

method TriggerBeforeActivate(sessionId: Guid)

 

void TriggerBeforeActivate(Guid sessionId)

 

Sub TriggerBeforeActivate(sessionId As Guid)

Parameters:

  • sessionId: Session Id

TriggerBeforeBeginTransaction  protected

 

method TriggerBeforeBeginTransaction(e: TransactionOperationEventArgs)

 

void TriggerBeforeBeginTransaction(TransactionOperationEventArgs e)

 

Sub TriggerBeforeBeginTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerBeforeCommitTransaction  protected

 

method TriggerBeforeCommitTransaction(e: TransactionOperationEventArgs)

 

void TriggerBeforeCommitTransaction(TransactionOperationEventArgs e)

 

Sub TriggerBeforeCommitTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerBeforeDeactivate  protected    (declared in Service)

Raises the Service event.

 

method TriggerBeforeDeactivate(sessionId: Guid)

 

void TriggerBeforeDeactivate(Guid sessionId)

 

Sub TriggerBeforeDeactivate(sessionId As Guid)

Parameters:

  • sessionId: Session Id

TriggerBeforeExecuteCommand (DataAbstractServiceExecuteCommandEventArgs)  protected

 

method TriggerBeforeExecuteCommand(e: DataAbstractServiceExecuteCommandEventArgs)

 

void TriggerBeforeExecuteCommand(DataAbstractServiceExecuteCommandEventArgs e)

 

Sub TriggerBeforeExecuteCommand(e As DataAbstractServiceExecuteCommandEventArgs)

Parameters:

  • e:

TriggerBeforeExecuteCommand (ExecuteCommandArgs)  protected

 

method TriggerBeforeExecuteCommand(e: ExecuteCommandArgs)

 

void TriggerBeforeExecuteCommand(ExecuteCommandArgs e)

 

Sub TriggerBeforeExecuteCommand(e As ExecuteCommandArgs)

Parameters:

  • e:

TriggerBeforeExecutingGetDataReader  protected

 

method TriggerBeforeExecutingGetDataReader(e: BeforeExecutingGetDataReaderEventArgs)

 

void TriggerBeforeExecutingGetDataReader(BeforeExecutingGetDataReaderEventArgs e)

 

Sub TriggerBeforeExecutingGetDataReader(e As BeforeExecutingGetDataReaderEventArgs)

Parameters:

  • e:

TriggerBeforeFindServiceSchema  protected

 

method TriggerBeforeFindServiceSchema(e: BeforeFindServiceSchemaEventArgs)

 

void TriggerBeforeFindServiceSchema(BeforeFindServiceSchemaEventArgs e)

 

Sub TriggerBeforeFindServiceSchema(e As BeforeFindServiceSchemaEventArgs)

Parameters:

  • e:

TriggerBeforeGetData  protected

 

method TriggerBeforeGetData(e: DataAbstractServiceGetDataEventArgs)

 

void TriggerBeforeGetData(DataAbstractServiceGetDataEventArgs e)

 

Sub TriggerBeforeGetData(e As DataAbstractServiceGetDataEventArgs)

Parameters:

  • e:

TriggerBeforeGetSchema  protected

 

method TriggerBeforeGetSchema(e: DataAbstractServiceGetSchemaEventArgs)

 

void TriggerBeforeGetSchema(DataAbstractServiceGetSchemaEventArgs e)

 

Sub TriggerBeforeGetSchema(e As DataAbstractServiceGetSchemaEventArgs)

Parameters:

  • e:

TriggerBeforeGetTableData  protected

 

method TriggerBeforeGetTableData(e: BeforeGetTableDataEventArgs)

 

void TriggerBeforeGetTableData(BeforeGetTableDataEventArgs e)

 

Sub TriggerBeforeGetTableData(e As BeforeGetTableDataEventArgs)

Parameters:

  • e:

TriggerBeforeProcessChange  protected

 

method TriggerBeforeProcessChange(e: DeltaChangeEventArgs)

 

void TriggerBeforeProcessChange(DeltaChangeEventArgs e)

 

Sub TriggerBeforeProcessChange(e As DeltaChangeEventArgs)

Parameters:

  • e:

TriggerBeforeProcessDelta  protected

 

method TriggerBeforeProcessDelta(e: DeltaEventArgs)

 

void TriggerBeforeProcessDelta(DeltaEventArgs e)

 

Sub TriggerBeforeProcessDelta(e As DeltaEventArgs)

Parameters:

  • e:

TriggerBeforeReleaseConnection  protected

 

method TriggerBeforeReleaseConnection(e: ConnectionOperationEventArgs)

 

void TriggerBeforeReleaseConnection(ConnectionOperationEventArgs e)

 

Sub TriggerBeforeReleaseConnection(e As ConnectionOperationEventArgs)

Parameters:

  • e:

TriggerBeforeRollBackTransaction  protected

 

method TriggerBeforeRollBackTransaction(e: TransactionOperationEventArgs)

 

void TriggerBeforeRollBackTransaction(TransactionOperationEventArgs e)

 

Sub TriggerBeforeRollBackTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerBeforeUpdateData  protected

 

method TriggerBeforeUpdateData(e: DataAbstractServiceUpdateDataEventArgs)

 

void TriggerBeforeUpdateData(DataAbstractServiceUpdateDataEventArgs e)

 

Sub TriggerBeforeUpdateData(e As DataAbstractServiceUpdateDataEventArgs)

Parameters:

  • e:

TriggerProcessError  protected

 

method TriggerProcessError(e: DeltaChangeErrorEventArgs)

 

void TriggerProcessError(DeltaChangeErrorEventArgs e)

 

Sub TriggerProcessError(e As DeltaChangeErrorEventArgs)

Parameters:

  • e:

TriggerUpdateDataError  protected

 

method TriggerUpdateDataError(e: DataAbstractServiceUpdateDataEventArgs)

 

void TriggerUpdateDataError(DataAbstractServiceUpdateDataEventArgs e)

 

Sub TriggerUpdateDataError(e As DataAbstractServiceUpdateDataEventArgs)

Parameters:

  • e:

TriggerValidateCommandExecution  protected

 

method TriggerValidateCommandExecution(e: ValidateSchemaObjectAccessEventArgs)

 

void TriggerValidateCommandExecution(ValidateSchemaObjectAccessEventArgs e)

 

Sub TriggerValidateCommandExecution(e As ValidateSchemaObjectAccessEventArgs)

Parameters:

  • e:

TriggerValidateDataTableAccess  protected

 

method TriggerValidateDataTableAccess(e: ValidateSchemaObjectAccessEventArgs)

 

void TriggerValidateDataTableAccess(ValidateSchemaObjectAccessEventArgs e)

 

Sub TriggerValidateDataTableAccess(e As ValidateSchemaObjectAccessEventArgs)

Parameters:

  • e:

TriggerValidateDirectSQLAccess  protected

 

method TriggerValidateDirectSQLAccess(e: ValidateDirectSQLAccessEventArgs)

 

void TriggerValidateDirectSQLAccess(ValidateDirectSQLAccessEventArgs e)

 

Sub TriggerValidateDirectSQLAccess(e As ValidateDirectSQLAccessEventArgs)

Parameters:

  • e:

TriggerValidateRoles  protected    (declared in Service)

Raises the Service event and returns the roles check result.

 

method TriggerValidateRoles(roles: array of String; allowByDefault: Boolean): Boolean

 

Boolean TriggerValidateRoles(String[] roles, Boolean allowByDefault)

 

Function TriggerValidateRoles(roles As String(), allowByDefault As Boolean) As Boolean

Parameters:

  • roles: Required servcie roles
  • allowByDefault: Default result returned when there are no event handlers for the Service event

UnknownSqlMacroIdentifier

Fires when unknown macro variable is found. it can be usable when user-defined variables are used inside sql or Dynamic Where expression.

 

event UnknownSqlMacroIdentifier: EventHandler<CustomSqlMacroEventArgs>;

 

delegate EventHandler<CustomSqlMacroEventArgs> UnknownSqlMacroIdentifier()

 

Event UnknownSqlMacroIdentifier As EventHandler<CustomSqlMacroEventArgs>

UnregisterAllBusinessProcessors  protected

 

method UnregisterAllBusinessProcessors

 

void UnregisterAllBusinessProcessors()

 

Sub UnregisterAllBusinessProcessors()

UnregisterBusinessProcessor

 

method UnregisterBusinessProcessor(processor: BusinessProcessor)

 

void UnregisterBusinessProcessor(BusinessProcessor processor)

 

Sub UnregisterBusinessProcessor(processor As BusinessProcessor)

Parameters:

  • processor:

UnregisterForDataChangeNotification

 

method UnregisterForDataChangeNotification(tableName: String)

 

void UnregisterForDataChangeNotification(String tableName)

 

Sub UnregisterForDataChangeNotification(tableName As String)

Parameters:

  • tableName:

UnsubscribeClientEventSink    (declared in Service)

This method unregisters the current client as receiver of the any events.

 

method UnsubscribeClientEventSink

 

void UnsubscribeClientEventSink()

 

Sub UnsubscribeClientEventSink()

UnsubscribeClientEventSink (Type)    (declared in Service)

This method unregisters the current client as receiver of the provided events type.

 

method UnsubscribeClientEventSink(eventSink: Type)

 

void UnsubscribeClientEventSink(Type eventSink)

 

Sub UnsubscribeClientEventSink(eventSink As Type)

Parameters:

  • eventSink: Event sink type

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(serializedDelta: Binary): Binary

 

Binary UpdateData(Binary serializedDelta)

 

Function UpdateData(serializedDelta As Binary) As Binary

Parameters:

  • serializedDelta:

UpdateDataError

Occurs if errors are encountered while applying updates to the database as part of a call to UpdateData. You can use this event to perform custom actions before handling the errors.

 

event UpdateDataError: DataAbstractServiceUpdateDataEventHandler;
delegate:  method UpdateDataError(sender: DataAbstractService; e: DataAbstractServiceUpdateDataEventArgs)

 

delegate DataAbstractServiceUpdateDataEventHandler UpdateDataError()
delegate:  void UpdateDataError(DataAbstractService sender, DataAbstractServiceUpdateDataEventArgs e)

 

Event UpdateDataError As DataAbstractServiceUpdateDataEventHandler
delegate:  Sub UpdateDataError(sender As DataAbstractService, e As DataAbstractServiceUpdateDataEventArgs)

ValidateCommandExecution

 

event ValidateCommandExecution: EventHandler<ValidateSchemaObjectAccessEventArgs>;

 

delegate EventHandler<ValidateSchemaObjectAccessEventArgs> ValidateCommandExecution()

 

Event ValidateCommandExecution As EventHandler<ValidateSchemaObjectAccessEventArgs>

ValidateDataTableAccess

 

event ValidateDataTableAccess: EventHandler<ValidateSchemaObjectAccessEventArgs>;

 

delegate EventHandler<ValidateSchemaObjectAccessEventArgs> ValidateDataTableAccess()

 

Event ValidateDataTableAccess As EventHandler<ValidateSchemaObjectAccessEventArgs>

ValidateDirectSQLAccess

 

event ValidateDirectSQLAccess: EventHandler<ValidateDirectSQLAccessEventArgs>;

 

delegate EventHandler<ValidateDirectSQLAccessEventArgs> ValidateDirectSQLAccess()

 

Event ValidateDirectSQLAccess As EventHandler<ValidateDirectSQLAccessEventArgs>

ValidateRoles    (declared in Service)

This event is triggered for methods that have roles set and can be used to override the default roles check procedure.

 

event ValidateRoles: EventHandler<ValidateRolesEventArgs>;

 

delegate EventHandler<ValidateRolesEventArgs> ValidateRoles()

 

Event ValidateRoles As EventHandler<ValidateRolesEventArgs>

 

AcquireConnection

Toggles whether the service can automatically acquire a connection when it is activated. If set to true, the service will automatically obtain a connection to be used for data access whenever the service is activated and will automatically release the connection when the service is deactivated. The name specified in ConnectionName will determine what type of connection will be acquired; the Connection property will give access to the current connection.

 

property AcquireConnection: Boolean read write;

 

Boolean AcquireConnection { get; set; }

 

Property AcquireConnection() As Boolean

AllowAllFieldsInDynamicWhere

By security reasons, only fields that are present in table definition can be used in Dynamic Where expression.

This property allows to override default behavior and use any fields in such expressions. (Default value is False).

 

property AllowAllFieldsInDynamicWhere: Boolean read write;

 

Boolean AllowAllFieldsInDynamicWhere { get; set; }

 

Property AllowAllFieldsInDynamicWhere() As Boolean

AllowCustomSqlMacros

Allows clients to use custom variables of Macro Processor.

 

property AllowCustomSqlMacros: Boolean read write;

 

Boolean AllowCustomSqlMacros { get; set; }

 

Property AllowCustomSqlMacros() As Boolean

AllowDataAccess

Allows the clients to access Schema information from the published schema (true, default) or not(false).

 

property AllowDataAccess: Boolean read write;

 

Boolean AllowDataAccess { get; set; }

 

Property AllowDataAccess() As Boolean

AllowDynamicOrder

Allows clients to use Dynamic Order feature.

 

property AllowDynamicOrder: Boolean read write;

 

Boolean AllowDynamicOrder { get; set; }

 

Property AllowDynamicOrder() As Boolean

AllowDynamicSelect

Allows clients to use Dynamic Select feature.

 

property AllowDynamicSelect: Boolean read write;

 

Boolean AllowDynamicSelect { get; set; }

 

Property AllowDynamicSelect() As Boolean

AllowDynamicWhere

Allows clients to use Dynamic Where feature.

 

property AllowDynamicWhere: Boolean read write;

 

Boolean AllowDynamicWhere { get; set; }

 

Property AllowDynamicWhere() As Boolean

AllowExecuteCommands

Allows clients to execute commands that are published in the Schema (true) or not (false, default).

Set this property to true if you want to enable clients to manually execute commands defined in the ServiceSchema.

 

property AllowExecuteCommands: Boolean read write;

 

Boolean AllowExecuteCommands { get; set; }

 

Property AllowExecuteCommands() As Boolean

AllowExecuteDASQL

Allows clients to use DA SQL feature.

 

property AllowExecuteDASQL: Boolean read write;

 

Boolean AllowExecuteDASQL { get; set; }

 

Property AllowExecuteDASQL() As Boolean

AllowExecuteSQL

Gets or sets a flag indicating whether direct access to the underlying database is allowed.

When set to true allows execution of custom SQL queries as commands or for retrieving data bypassing the published server schema via the SQLGetData, SQLGetDataEx, SQLExecuteCommand and SQLExecuteCommandEx methods.

Note: Enabling this option opens a huge security risk as client applications can send any custom SQL text to the server for execution, including code that could potentially harm or even destroy the database.

The default value is false.

 

property AllowExecuteSQL: Boolean read write;

 

Boolean AllowExecuteSQL { get; set; }

 

Property AllowExecuteSQL() As Boolean

AllowHttpSchemaAccess

Using this property, you can allow or forbid access to the service schema by any client over HTTP protocol When AllowHttpSchemaAccess is set to True, the service schema could be retrieved via urls like http://myserver:8099/MyDAService

If you don't want to allow clients to get your service schema directly via HTTP (usually this can be a security issue), you need to set AllowHttpSchemaAccess to false and the server will raise a proper exception when somebody tries to get access to the service schema via HTTP.

You should understand the difference between AllowSchemaAccess and AllowHttpSchemaAccess properties. While AllowSchemaAccess property manages access to the Service Schema in general, AllowHttpSchemaAccess manages access to the Service Schema via HTTP only. That said you should have both these properties set to True for accessing service schema via HTTP.

Obviously this option is applicable only when the server is using http-based server channels.

 

property AllowHttpSchemaAccess: Boolean read write;

 

Boolean AllowHttpSchemaAccess { get; set; }

 

Property AllowHttpSchemaAccess() As Boolean

AllowSchemaAccess

Allows clients to access data from the published Schema (true, default) or not (false). Access to schema information from the server is often helpful while designing the client application since most clients do not need to refresh schema information from the server at runtime.

Although proper use of user authentication will restrict access, disabling this option for production servers prevents unnecessarily exposing the server schema to the outside world.

 

property AllowSchemaAccess: Boolean read write;

 

Boolean AllowSchemaAccess { get; set; }

 

Property AllowSchemaAccess() As Boolean

AllowUpdates

Allows clients to update data.

 

property AllowUpdates: Boolean read write;

 

Boolean AllowUpdates { get; set; }

 

Property AllowUpdates() As Boolean

AutoCreateBusinessProcessors

Instructs the service to create a business processor for each of the data tables that are being updated in an UpdateData call, if no explicit BusinessProcessor has been dropped at design time.

Set this property to true to allow automatic handling of updates to all data tables; set it to false to only allow data updates through manually configured BusinessProcessor components dropped onto your service.

 

property AutoCreateBusinessProcessors: Boolean read write;

 

Boolean AutoCreateBusinessProcessors { get; set; }

 

Property AutoCreateBusinessProcessors() As Boolean

BusinessProcessors

This property lists all the business processors the service owns. This list includes both automatically created business processors and those explicitly dropped on the service at design time.

 

property BusinessProcessors: IDictionary<String, BusinessProcessor> read;

 

IDictionary<String, BusinessProcessor> BusinessProcessors { get; }

 

ReadOnly Property BusinessProcessors() As IDictionary<String, BusinessProcessor>

CanBeDisposed    (declared in Service)

Get a flag indicating whether the current service instance can be disposed after servicing the request.

 

property CanBeDisposed: Boolean read;

 

Boolean CanBeDisposed { get; }

 

ReadOnly Property CanBeDisposed() As Boolean

Connection

Lets you access the connection that is automatically created by the service if the property AcquireConnection is set to true.

 

property Connection: IAbstractConnection read write;

 

IAbstractConnection Connection { get; set; }

 

Property Connection() As IAbstractConnection

ConnectionName

Determines the name of the connection to acquire whenever AcquireConnection is true. If the string is empty, the service will acquire the connection marked as default.

 

property ConnectionName: String read write;

 

String ConnectionName { get; set; }

 

Property ConnectionName() As String

ConnectionTimeout

 

property ConnectionTimeout: Int32 read write;

 

Int32 ConnectionTimeout { get; set; }

 

Property ConnectionTimeout() As Int32

DASqlProcessor

 

property DASqlProcessor: DASqlProcessor read write;

 

DASqlProcessor DASqlProcessor { get; set; }

 

Property DASqlProcessor() As DASqlProcessor

EventSinkManager  protected    (declared in Service)

Provides access to the event sink manager that should be used by the service methods.

 

property EventSinkManager: IEventSinkManager read;

 

IEventSinkManager EventSinkManager { get; }

 

ReadOnly Property EventSinkManager() As IEventSinkManager

HasSession    (declared in Service)

Gets a flag indicating whether a session is accessible (ie Service is set and the session itself exists for the current remote client)

 

property HasSession: Boolean read;

 

Boolean HasSession { get; }

 

ReadOnly Property HasSession() As Boolean

IsActive    (declared in Service)

 

property IsActive: Boolean read;

 

Boolean IsActive { get; }

 

ReadOnly Property IsActive() As Boolean

ProcessAllDeltas

Determines if the service should also process the deltas for which update rules have not been defined.

 

property ProcessAllDeltas: Boolean read write;

 

Boolean ProcessAllDeltas { get; set; }

 

Property ProcessAllDeltas() As Boolean

RequireSession    (declared in Service)

Gets or sets a flag ingicating wheter accessing this service methods remotely requres an existing session.

 

property RequireSession: Boolean read write;

 

Boolean RequireSession { get; set; }

 

Property RequireSession() As Boolean

Roles    (declared in Service)

 

property Roles: array of String read write;

 

String[] Roles { get; set; }

 

Property Roles() As String()

RollbackUpdatesOnError

 

property RollbackUpdatesOnError: Boolean read write;

 

Boolean RollbackUpdatesOnError { get; set; }

 

Property RollbackUpdatesOnError() As Boolean

ScriptProvider

 

property ScriptProvider: IScriptProvider read write;

 

IScriptProvider ScriptProvider { get; set; }

 

Property ScriptProvider() As IScriptProvider

ServerChannel    (declared in Service)

Gets a IServerChannelInfo instance providing information about the server channel used to call the service method remotely.

 

property ServerChannel: IServerChannelInfo read;

 

IServerChannelInfo ServerChannel { get; }

 

ReadOnly Property ServerChannel() As IServerChannelInfo

ServeSchema

 

property ServeSchema: Boolean read write;

 

Boolean ServeSchema { get; set; }

 

Property ServeSchema() As Boolean

ServiceDataStreamer

Identifies the DataStreamer associated with the service. Data streamers are used to encode the data streams used by the GetData and UpdateData methods.

 

property ServiceDataStreamer: DataStreamer read write;

 

DataStreamer ServiceDataStreamer { get; set; }

 

Property ServiceDataStreamer() As DataStreamer

ServiceSchema

Returns an instance of a schema that has loaded the schema file identified by the ServiceSchemaName.

 

property ServiceSchema: ServiceSchema read;

 

ServiceSchema ServiceSchema { get; }

 

ReadOnly Property ServiceSchema() As ServiceSchema

ServiceSchemaName

Identifies the name of the Schema resource the service has to load whenever the ServiceSchema property is accessed.

 

property ServiceSchemaName: String read write;

 

String ServiceSchemaName { get; set; }

 

Property ServiceSchemaName() As String

Session    (declared in Service)

Provides access to the Session for the current remote client. In case when session doesn't exist for the current client yet, a new session will be created when the Session property is accessed (but not before).

 

property Session: ISession read write;

 

ISession Session { get; set; }

 

Property Session() As ISession

SessionID    (declared in Service)

Gets the Session ID (aka remote client Id) for the request that is currently being executed.

 

property SessionID: Guid read;

 

Guid SessionID { get; }

 

ReadOnly Property SessionID() As Guid

SessionManager  protected    (declared in Service)

Provides access to the session manager that is used by the service.

 

property SessionManager: ISessionManager read;

 

ISessionManager SessionManager { get; }

 

ReadOnly Property SessionManager() As ISessionManager

 

BuildParameters  protected

 

class method BuildParameters(aReq: SimpleRequestInfo): array of DataParameter

 

static DataParameter[] BuildParameters(SimpleRequestInfo aReq)

 

Shared Function BuildParameters(aReq As SimpleRequestInfo) As DataParameter()

Parameters:

  • aReq:

 

constructor

Creates a new instance of the DataAbstractService class.

 

constructor

 

DataAbstractService()

 

Sub New()

constructor (ISessionManager)

Creates a new instance of the DataAbstractService class and sets the provided ISessionManager instance as session provider.

This constructor should be used when the service instance should use session manager other than one globally registered in the server app.

 

constructor(sessionManager: ISessionManager)

 

DataAbstractService(ISessionManager sessionManager)

 

Sub New(sessionManager As ISessionManager)

Parameters:

  • sessionManager: Custom Session Manager instance

Creates a new instance of the DataAbstractService class and sets the provided session provider and event sink manager.

This constructor should be used when the service instance should use session manager or event sink manager other than ones globally registered in the server app.

 

constructor(sessionManager: ISessionManager; eventManager: IEventSinkManager)

 

DataAbstractService(ISessionManager sessionManager, IEventSinkManager eventManager)

 

Sub New(sessionManager As ISessionManager, eventManager As IEventSinkManager)

Parameters:

  • sessionManager: Custom Session Manager instance
  • eventManager: Custom Event manager instance

Activate    (declared in Service)

 

method Activate(clientId: Guid; enforceSessionCheck: Boolean; roles: nullable array of String)

 

void Activate(Guid clientId, Boolean enforceSessionCheck, String[]? roles)

 

Sub Activate(clientId As Guid, enforceSessionCheck As Boolean, roles As String()?)

Parameters:

  • clientId:
  • enforceSessionCheck:
  • roles:

BeginTransaction  protected

 

method BeginTransaction(var connection: IAbstractConnection): Int32

 

Int32 BeginTransaction(ref IAbstractConnection connection)

 

Function BeginTransaction(ByRef connection As IAbstractConnection) As Int32

Parameters:

  • connection:

CheckConnection  protected

 

method CheckConnection

 

void CheckConnection()

 

Sub CheckConnection()

CommitTransaction  protected

 

method CommitTransaction(connection: IAbstractConnection)

 

void CommitTransaction(IAbstractConnection connection)

 

Sub CommitTransaction(connection As IAbstractConnection)

Parameters:

  • connection:

CustomMacroHandler  protected

 

method CustomMacroHandler(name: String; originalName: String; var value: String): Boolean

 

Boolean CustomMacroHandler(String name, String originalName, ref String value)

 

Function CustomMacroHandler(name As String, originalName As String, ByRef value As String) As Boolean

Parameters:

  • name:
  • originalName:
  • value:

Deactivate    (declared in Service)

Deactivates the service instance.

This method raises the Service and Service events and releases the service session.

 

method Deactivate(clientId: Guid)

 

void Deactivate(Guid clientId)

 

Sub Deactivate(clientId As Guid)

Parameters:

  • clientId: Session Id

DeserializeDeltas  protected

Deserializes the provided Binary stream as a Deltas collection.

This method uses the ServiceDataStreamer data streamer to perform the deserialization task.

 

method DeserializeDeltas(source: Binary): RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>

 

RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta> DeserializeDeltas(Binary source)

 

Function DeserializeDeltas(source As Binary) As RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>

Parameters:

  • source: Source data stream containing serialized Deltas collection

DestroySession  protected    (declared in Service)

Destroys and disposes the current session.

This method is widely used in the login services to destroy the user session after logout or in case the login attempt was not successful.

 

method DestroySession

 

void DestroySession()

 

Sub DestroySession()

Dispose  protected

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

DropConnection  protected

Drops the provided connection.

 

method DropConnection(connection: IAbstractConnection)

 

void DropConnection(IAbstractConnection connection)

 

Sub DropConnection(connection As IAbstractConnection)

Parameters:

  • connection: Connection to drop

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(commandName: String; parameters: array of DataParameter): Int32

 

Int32 ExecuteCommand(String commandName, DataParameter[] parameters)

 

Function ExecuteCommand(commandName As String, parameters As DataParameter()) As Int32

Parameters:

  • commandName:
  • parameters:

ExecuteCommandEx

 

method ExecuteCommandEx(commandName: String; inputParameters: array of DataParameter; out outputParameters: array of DataParameter): Int32

 

Int32 ExecuteCommandEx(String commandName, DataParameter[] inputParameters, out DataParameter[] outputParameters)

 

Function ExecuteCommandEx(commandName As String, inputParameters As DataParameter(), <OutAttribute> ByRef outputParameters As DataParameter()) As Int32

Parameters:

  • commandName:
  • inputParameters:
  • outputParameters:

GetBusinessProcessor  protected

 

method GetBusinessProcessor(tableName: String; createIfNeeded: Boolean): BusinessProcessor

 

BusinessProcessor GetBusinessProcessor(String tableName, Boolean createIfNeeded)

 

Function GetBusinessProcessor(tableName As String, createIfNeeded As Boolean) As BusinessProcessor

Parameters:

  • tableName:
  • createIfNeeded:

GetCommandSchema

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

 

method GetCommandSchema(commandNames: array of String): String

 

String GetCommandSchema(String[] commandNames)

 

Function GetCommandSchema(commandNames As String()) As String

Parameters:

  • commandNames:

GetConnection  protected

 

method GetConnection: IAbstractConnection

 

IAbstractConnection GetConnection()

 

Function GetConnection() As IAbstractConnection

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 or 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(tableNames: array of String; requestInfo: array of TableRequestInfo): Binary

 

Binary GetData(String[] tableNames, TableRequestInfo[] requestInfo)

 

Function GetData(tableNames As String(), requestInfo As TableRequestInfo()) As Binary

Parameters:

  • tableNames:
  • requestInfo:

GetDatasetScripts

 

method GetDatasetScripts(tableNames: String): String

 

String GetDatasetScripts(String tableNames)

 

Function GetDatasetScripts(tableNames As String) As String

Parameters:

  • tableNames:

GetEventSink (Type): IROEventSink    (declared in Service)

Obtains an event sink proxy for the specified interface.

 

method GetEventSink(eventSink: Type): IROEventSink

 

IROEventSink GetEventSink(Type eventSink)

 

Function GetEventSink(eventSink As Type) As IROEventSink

Parameters:

  • eventSink: Event sink type

GetEventSink (Type, IEventTargets): IROEventSink    (declared in Service)

Obtains an event sink proxy for the specified interface. This method allows to manage the event recipients.

 

method GetEventSink(eventSink: Type; eventTargets: IEventTargets): IROEventSink

 

IROEventSink GetEventSink(Type eventSink, IEventTargets eventTargets)

 

Function GetEventSink(eventSink As Type, eventTargets As IEventTargets) As IROEventSink

Parameters:

  • eventSink: Event sink type
  • eventTargets: Event recepients

GetEventSink (Type, array of Guid): IROEventSink    (declared in Service)

Obtains an event sink proxy for the specified interface. This method allows to set the event recipients.

 

method GetEventSink(eventSink: Type; recipients: array of Guid): IROEventSink

 

IROEventSink GetEventSink(Type eventSink, Guid[] recipients)

 

Function GetEventSink(eventSink As Type, recipients As Guid()) As IROEventSink

Parameters:

  • eventSink: Event sink type
  • recipients: Event recipients

GetEventSink<T>    (declared in Service)

 

method GetEventSink<T>: T

 

T GetEventSink<T>()

 

Function GetEventSink<T>() As T

GetEventSink<T> (IEventTargets): T    (declared in Service)

 

method GetEventSink<T>(eventTargets: IEventTargets): T

 

T GetEventSink<T>(IEventTargets eventTargets)

 

Function GetEventSink<T>(eventTargets As IEventTargets) As T

Parameters:

  • eventTargets:

GetEventSink<T> (array of Guid): T    (declared in Service)

 

method GetEventSink<T>(recipients: array of Guid): T

 

T GetEventSink<T>(Guid[] recipients)

 

Function GetEventSink<T>(recipients As Guid()) As T

Parameters:

  • recipients:

GetSchema

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

 

method GetSchema(filter: String): String

 

String GetSchema(String filter)

 

Function GetSchema(filter As String) As String

Parameters:

  • filter:

GetScriptContext  protected

 

method GetScriptContext: IServerScriptContext

 

IServerScriptContext GetScriptContext()

 

Function GetScriptContext() As IServerScriptContext

GetScriptDebugger  protected

 

method GetScriptDebugger: IScriptDebugger

 

IScriptDebugger GetScriptDebugger()

 

Function GetScriptDebugger() As IScriptDebugger

GetSession  protected    (declared in Service)

Gets the service session. Unlike the Service property this method returns null instead of throwing an exception in case the Service is not set.

 

method GetSession: ISession

 

ISession GetSession()

 

Function GetSession() As ISession

GetTableSchema

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

 

method GetTableSchema(tableNames: array of String): String

 

String GetTableSchema(String[] tableNames)

 

Function GetTableSchema(tableNames As String()) As String

Parameters:

  • tableNames:

InitializeScriptProvider  protected

 

method InitializeScriptProvider

 

void InitializeScriptProvider()

 

Sub InitializeScriptProvider()

InitializeServiceSchema  protected

 

method InitializeServiceSchema

 

void InitializeServiceSchema()

 

Sub InitializeServiceSchema()

InitializeServiceSchemaAndScriptProvider

 

method InitializeServiceSchemaAndScriptProvider(ignoreCache: Boolean)

 

void InitializeServiceSchemaAndScriptProvider(Boolean ignoreCache)

 

Sub InitializeServiceSchemaAndScriptProvider(ignoreCache As Boolean)

Parameters:

  • ignoreCache:

ProcessDelta  protected

 

method ProcessDelta(delta: Delta; allowInsert: Boolean; allowUpdate: Boolean; allowDelete: Boolean; detailDeltas: RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>)

 

void ProcessDelta(Delta delta, Boolean allowInsert, Boolean allowUpdate, Boolean allowDelete, RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta> detailDeltas)

 

Sub ProcessDelta(delta As Delta, allowInsert As Boolean, allowUpdate As Boolean, allowDelete As Boolean, detailDeltas As RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>)

Parameters:

  • delta:
  • allowInsert:
  • allowUpdate:
  • allowDelete:
  • detailDeltas:

RegisterAllBusinessProcessors  protected

 

method RegisterAllBusinessProcessors

 

void RegisterAllBusinessProcessors()

 

Sub RegisterAllBusinessProcessors()

RegisterBusinessProcessor

 

method RegisterBusinessProcessor(processor: BusinessProcessor)

 

void RegisterBusinessProcessor(BusinessProcessor processor)

 

Sub RegisterBusinessProcessor(processor As BusinessProcessor)

Parameters:

  • processor:

RegisterForDataChangeNotification

 

method RegisterForDataChangeNotification(tableName: String)

 

void RegisterForDataChangeNotification(String tableName)

 

Sub RegisterForDataChangeNotification(tableName As String)

Parameters:

  • tableName:

ReleaseConnection  protected

Releases provided connection back to the connection pool provided by the ConnectionManager.

 

method ReleaseConnection(connection: IAbstractConnection)

 

void ReleaseConnection(IAbstractConnection connection)

 

Sub ReleaseConnection(connection As IAbstractConnection)

Parameters:

  • connection: Connection to release

ReloadScript

 

method ReloadScript

 

void ReloadScript()

 

Sub ReloadScript()

RollbackTransaction  protected

 

method RollbackTransaction(connection: IAbstractConnection)

 

void RollbackTransaction(IAbstractConnection connection)

 

Sub RollbackTransaction(connection As IAbstractConnection)

Parameters:

  • connection:

SerializeDeltas  protected

Serializes the provided Deltas collection into a Binary stream.

This method uses the ServiceDataStreamer data streamer to perform the serialization task.

 

method SerializeDeltas(deltas: RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>): Binary

 

Binary SerializeDeltas(RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta> deltas)

 

Function SerializeDeltas(deltas As RemObjects.Common.Collections.NamedObjectCollection<RemObjects.DataAbstract.Delta>) As Binary

Parameters:

  • deltas: Source Deltas collection

ServiceValidateRoles    (declared in Service)

Validates the service roles. This method is used by the service invoker methods to validate the server access roles.

See the IRolesAwareService interface description for more details.

 

method ServiceValidateRoles(requiredRoles: array of String)

 

void ServiceValidateRoles(String[] requiredRoles)

 

Sub ServiceValidateRoles(requiredRoles As String())

Parameters:

  • requiredRoles: Required service roles

SetupDASqlProcessor  protected

 

method SetupDASqlProcessor

 

void SetupDASqlProcessor()

 

Sub SetupDASqlProcessor()

SimpleGetData

 

method SimpleGetData(requestInfo: array of SimpleRequestInfo): array of SimpleDataResult

 

SimpleDataResult[] SimpleGetData(SimpleRequestInfo[] requestInfo)

 

Function SimpleGetData(requestInfo As SimpleRequestInfo()) As SimpleDataResult()

Parameters:

  • requestInfo:

SimpleUpdateData

 

method SimpleUpdateData(delta: array of SimpleDelta): array of SimpleDelta

 

SimpleDelta[] SimpleUpdateData(SimpleDelta[] delta)

 

Function SimpleUpdateData(delta As SimpleDelta()) As SimpleDelta()

Parameters:

  • delta:

SQLExecuteCommand

Executes the provided SQL statement AS IS at the underlying database server bypassing any Schema validation procedures on it.

Note: Allowing clients to execute arbitrary SQL statements is a high security risk and should only be allowed with caution.

The AllowExecuteSQL property is set to false by default, preventing direct SQL commands from being executed.

 

method SQLExecuteCommand(sql: String): Int32

 

Int32 SQLExecuteCommand(String sql)

 

Function SQLExecuteCommand(sql As String) As Int32

Parameters:

  • sql: SQL statement

SQLExecuteCommandEx

Executes the provided SQL statement AS IS at the underlying database server bypassing any Schema validation procedures on it.

Note: Allowing clients to execute arbitrary SQL statements is a high security risk and should only be allowed with caution.

The AllowExecuteSQL property is set to false by default, preventing direct SQL commands from being executed.

 

method SQLExecuteCommandEx(sql: String; dynamicWhere: String): Int32

 

Int32 SQLExecuteCommandEx(String sql, String dynamicWhere)

 

Function SQLExecuteCommandEx(sql As String, dynamicWhere As String) As Int32

Parameters:

  • sql: SQL statement
  • dynamicWhere: DynamicWhere condition that will be applied to the command execution result

SQLGetData

Executes the provided SQL statement AS IS at the underlying database server bypassing any Schema validation procedures on it and returns its serialized result to the caller.

Note: Allowing clients to execute arbitrary SQL statements is a high security risk and should only be allowed with caution.

The AllowExecuteSQL property is set to false by default, preventing direct SQL commands from being executed.

 

method SQLGetData(sql: String; includeSchema: Boolean; maxRecords: Int32): Binary

 

Binary SQLGetData(String sql, Boolean includeSchema, Int32 maxRecords)

 

Function SQLGetData(sql As String, includeSchema As Boolean, maxRecords As Int32) As Binary

Parameters:

  • sql: SQL statement
  • includeSchema: Include Schema of the resulting data ito the output data stream
  • maxRecords: Maximum numer of records that will be returned in the data stream; -1 means that no limits are applied

SQLGetDataEx

Executes the provided SQL statement AS IS at the underlying database server bypassing any Schema validation procedures on it and returns its serialized result to the caller.

Note: Allowing clients to execute arbitrary SQL statements is a high security risk and should only be allowed with caution.

The AllowExecuteSQL property is set to false by default, preventing direct SQL commands from being executed.

 

method SQLGetDataEx(sql: String; includeSchema: Boolean; maxRecords: Int32; dynamicWhere: String): Binary

 

Binary SQLGetDataEx(String sql, Boolean includeSchema, Int32 maxRecords, String dynamicWhere)

 

Function SQLGetDataEx(sql As String, includeSchema As Boolean, maxRecords As Int32, dynamicWhere As String) As Binary

Parameters:

  • sql: SQL statement
  • includeSchema: Include Schema of the resulting data ito the output data stream
  • maxRecords: Maximum numer of records that will be returned in the data stream; -1 means that no limits are applied
  • dynamicWhere: DynamicWhere condition that will be applied to the statement execution result

SubscribeClientEventSink    (declared in Service)

This method registers the current client as receiver of the provided events type.

 

method SubscribeClientEventSink(eventSink: Type)

 

void SubscribeClientEventSink(Type eventSink)

 

Sub SubscribeClientEventSink(eventSink As Type)

Parameters:

  • eventSink: Event sink type

TriggerAfterAcquireConnection  protected

 

method TriggerAfterAcquireConnection(e: ConnectionOperationEventArgs)

 

void TriggerAfterAcquireConnection(ConnectionOperationEventArgs e)

 

Sub TriggerAfterAcquireConnection(e As ConnectionOperationEventArgs)

Parameters:

  • e:

TriggerAfterActivate  protected    (declared in Service)

Raises the Service event.

 

method TriggerAfterActivate(sessionId: Guid)

 

void TriggerAfterActivate(Guid sessionId)

 

Sub TriggerAfterActivate(sessionId As Guid)

Parameters:

  • sessionId: Session Id

TriggerAfterAutoCreateBusinessProcessor  protected

 

method TriggerAfterAutoCreateBusinessProcessor(e: BusinessProcessorAutoCreatedEventArgs)

 

void TriggerAfterAutoCreateBusinessProcessor(BusinessProcessorAutoCreatedEventArgs e)

 

Sub TriggerAfterAutoCreateBusinessProcessor(e As BusinessProcessorAutoCreatedEventArgs)

Parameters:

  • e:

TriggerAfterBeginTransaction  protected

 

method TriggerAfterBeginTransaction(e: TransactionOperationEventArgs)

 

void TriggerAfterBeginTransaction(TransactionOperationEventArgs e)

 

Sub TriggerAfterBeginTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerAfterCommitTransaction  protected

 

method TriggerAfterCommitTransaction(e: TransactionOperationEventArgs)

 

void TriggerAfterCommitTransaction(TransactionOperationEventArgs e)

 

Sub TriggerAfterCommitTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerAfterDeactivate  protected    (declared in Service)

Raises the Service event.

 

method TriggerAfterDeactivate(sessionId: Guid)

 

void TriggerAfterDeactivate(Guid sessionId)

 

Sub TriggerAfterDeactivate(sessionId As Guid)

Parameters:

  • sessionId: Session Id

TriggerAfterExecuteCommand (DataAbstractServiceExecuteCommandEventArgs)  protected

 

method TriggerAfterExecuteCommand(e: DataAbstractServiceExecuteCommandEventArgs)

 

void TriggerAfterExecuteCommand(DataAbstractServiceExecuteCommandEventArgs e)

 

Sub TriggerAfterExecuteCommand(e As DataAbstractServiceExecuteCommandEventArgs)

Parameters:

  • e:

TriggerAfterExecuteCommand (ExecuteCommandArgs)  protected

 

method TriggerAfterExecuteCommand(e: ExecuteCommandArgs)

 

void TriggerAfterExecuteCommand(ExecuteCommandArgs e)

 

Sub TriggerAfterExecuteCommand(e As ExecuteCommandArgs)

Parameters:

  • e:

TriggerAfterFindServiceSchema  protected

 

method TriggerAfterFindServiceSchema(e: ServiceSchemaOperationEventArgs)

 

void TriggerAfterFindServiceSchema(ServiceSchemaOperationEventArgs e)

 

Sub TriggerAfterFindServiceSchema(e As ServiceSchemaOperationEventArgs)

Parameters:

  • e:

TriggerAfterGetData  protected

 

method TriggerAfterGetData(e: DataAbstractServiceGetDataEventArgs)

 

void TriggerAfterGetData(DataAbstractServiceGetDataEventArgs e)

 

Sub TriggerAfterGetData(e As DataAbstractServiceGetDataEventArgs)

Parameters:

  • e:

TriggerAfterGetSchema  protected

 

method TriggerAfterGetSchema(e: DataAbstractServiceAfterGetSchemaEventArgs)

 

void TriggerAfterGetSchema(DataAbstractServiceAfterGetSchemaEventArgs e)

 

Sub TriggerAfterGetSchema(e As DataAbstractServiceAfterGetSchemaEventArgs)

Parameters:

  • e:

TriggerAfterProcessChange  protected

 

method TriggerAfterProcessChange(e: DeltaChangeEventArgs)

 

void TriggerAfterProcessChange(DeltaChangeEventArgs e)

 

Sub TriggerAfterProcessChange(e As DeltaChangeEventArgs)

Parameters:

  • e:

TriggerAfterProcessDelta  protected

 

method TriggerAfterProcessDelta(e: DeltaEventArgs)

 

void TriggerAfterProcessDelta(DeltaEventArgs e)

 

Sub TriggerAfterProcessDelta(e As DeltaEventArgs)

Parameters:

  • e:

TriggerAfterReleaseConnection  protected

 

method TriggerAfterReleaseConnection(e: ConnectionOperationEventArgs)

 

void TriggerAfterReleaseConnection(ConnectionOperationEventArgs e)

 

Sub TriggerAfterReleaseConnection(e As ConnectionOperationEventArgs)

Parameters:

  • e:

TriggerAfterRollBackTransaction  protected

 

method TriggerAfterRollBackTransaction(e: TransactionOperationEventArgs)

 

void TriggerAfterRollBackTransaction(TransactionOperationEventArgs e)

 

Sub TriggerAfterRollBackTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerAfterSqlGeneration  protected

 

method TriggerAfterSqlGeneration(e: SqlGenerationEventArgs)

 

void TriggerAfterSqlGeneration(SqlGenerationEventArgs e)

 

Sub TriggerAfterSqlGeneration(e As SqlGenerationEventArgs)

Parameters:

  • e:

TriggerAfterUpdateData  protected

 

method TriggerAfterUpdateData(e: DataAbstractServiceUpdateDataEventArgs)

 

void TriggerAfterUpdateData(DataAbstractServiceUpdateDataEventArgs e)

 

Sub TriggerAfterUpdateData(e As DataAbstractServiceUpdateDataEventArgs)

Parameters:

  • e:

TriggerBeforeAcquireConnection  protected

 

method TriggerBeforeAcquireConnection(e: BeforeAcquireConnectionEventArgs)

 

void TriggerBeforeAcquireConnection(BeforeAcquireConnectionEventArgs e)

 

Sub TriggerBeforeAcquireConnection(e As BeforeAcquireConnectionEventArgs)

Parameters:

  • e:

TriggerBeforeActivate  protected    (declared in Service)

Raises the Service event.

 

method TriggerBeforeActivate(sessionId: Guid)

 

void TriggerBeforeActivate(Guid sessionId)

 

Sub TriggerBeforeActivate(sessionId As Guid)

Parameters:

  • sessionId: Session Id

TriggerBeforeBeginTransaction  protected

 

method TriggerBeforeBeginTransaction(e: TransactionOperationEventArgs)

 

void TriggerBeforeBeginTransaction(TransactionOperationEventArgs e)

 

Sub TriggerBeforeBeginTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerBeforeCommitTransaction  protected

 

method TriggerBeforeCommitTransaction(e: TransactionOperationEventArgs)

 

void TriggerBeforeCommitTransaction(TransactionOperationEventArgs e)

 

Sub TriggerBeforeCommitTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerBeforeDeactivate  protected    (declared in Service)

Raises the Service event.

 

method TriggerBeforeDeactivate(sessionId: Guid)

 

void TriggerBeforeDeactivate(Guid sessionId)

 

Sub TriggerBeforeDeactivate(sessionId As Guid)

Parameters:

  • sessionId: Session Id

TriggerBeforeExecuteCommand (DataAbstractServiceExecuteCommandEventArgs)  protected

 

method TriggerBeforeExecuteCommand(e: DataAbstractServiceExecuteCommandEventArgs)

 

void TriggerBeforeExecuteCommand(DataAbstractServiceExecuteCommandEventArgs e)

 

Sub TriggerBeforeExecuteCommand(e As DataAbstractServiceExecuteCommandEventArgs)

Parameters:

  • e:

TriggerBeforeExecuteCommand (ExecuteCommandArgs)  protected

 

method TriggerBeforeExecuteCommand(e: ExecuteCommandArgs)

 

void TriggerBeforeExecuteCommand(ExecuteCommandArgs e)

 

Sub TriggerBeforeExecuteCommand(e As ExecuteCommandArgs)

Parameters:

  • e:

TriggerBeforeExecutingGetDataReader  protected

 

method TriggerBeforeExecutingGetDataReader(e: BeforeExecutingGetDataReaderEventArgs)

 

void TriggerBeforeExecutingGetDataReader(BeforeExecutingGetDataReaderEventArgs e)

 

Sub TriggerBeforeExecutingGetDataReader(e As BeforeExecutingGetDataReaderEventArgs)

Parameters:

  • e:

TriggerBeforeFindServiceSchema  protected

 

method TriggerBeforeFindServiceSchema(e: BeforeFindServiceSchemaEventArgs)

 

void TriggerBeforeFindServiceSchema(BeforeFindServiceSchemaEventArgs e)

 

Sub TriggerBeforeFindServiceSchema(e As BeforeFindServiceSchemaEventArgs)

Parameters:

  • e:

TriggerBeforeGetData  protected

 

method TriggerBeforeGetData(e: DataAbstractServiceGetDataEventArgs)

 

void TriggerBeforeGetData(DataAbstractServiceGetDataEventArgs e)

 

Sub TriggerBeforeGetData(e As DataAbstractServiceGetDataEventArgs)

Parameters:

  • e:

TriggerBeforeGetSchema  protected

 

method TriggerBeforeGetSchema(e: DataAbstractServiceGetSchemaEventArgs)

 

void TriggerBeforeGetSchema(DataAbstractServiceGetSchemaEventArgs e)

 

Sub TriggerBeforeGetSchema(e As DataAbstractServiceGetSchemaEventArgs)

Parameters:

  • e:

TriggerBeforeGetTableData  protected

 

method TriggerBeforeGetTableData(e: BeforeGetTableDataEventArgs)

 

void TriggerBeforeGetTableData(BeforeGetTableDataEventArgs e)

 

Sub TriggerBeforeGetTableData(e As BeforeGetTableDataEventArgs)

Parameters:

  • e:

TriggerBeforeProcessChange  protected

 

method TriggerBeforeProcessChange(e: DeltaChangeEventArgs)

 

void TriggerBeforeProcessChange(DeltaChangeEventArgs e)

 

Sub TriggerBeforeProcessChange(e As DeltaChangeEventArgs)

Parameters:

  • e:

TriggerBeforeProcessDelta  protected

 

method TriggerBeforeProcessDelta(e: DeltaEventArgs)

 

void TriggerBeforeProcessDelta(DeltaEventArgs e)

 

Sub TriggerBeforeProcessDelta(e As DeltaEventArgs)

Parameters:

  • e:

TriggerBeforeReleaseConnection  protected

 

method TriggerBeforeReleaseConnection(e: ConnectionOperationEventArgs)

 

void TriggerBeforeReleaseConnection(ConnectionOperationEventArgs e)

 

Sub TriggerBeforeReleaseConnection(e As ConnectionOperationEventArgs)

Parameters:

  • e:

TriggerBeforeRollBackTransaction  protected

 

method TriggerBeforeRollBackTransaction(e: TransactionOperationEventArgs)

 

void TriggerBeforeRollBackTransaction(TransactionOperationEventArgs e)

 

Sub TriggerBeforeRollBackTransaction(e As TransactionOperationEventArgs)

Parameters:

  • e:

TriggerBeforeUpdateData  protected

 

method TriggerBeforeUpdateData(e: DataAbstractServiceUpdateDataEventArgs)

 

void TriggerBeforeUpdateData(DataAbstractServiceUpdateDataEventArgs e)

 

Sub TriggerBeforeUpdateData(e As DataAbstractServiceUpdateDataEventArgs)

Parameters:

  • e:

TriggerProcessError  protected

 

method TriggerProcessError(e: DeltaChangeErrorEventArgs)

 

void TriggerProcessError(DeltaChangeErrorEventArgs e)

 

Sub TriggerProcessError(e As DeltaChangeErrorEventArgs)

Parameters:

  • e:

TriggerUpdateDataError  protected

 

method TriggerUpdateDataError(e: DataAbstractServiceUpdateDataEventArgs)

 

void TriggerUpdateDataError(DataAbstractServiceUpdateDataEventArgs e)

 

Sub TriggerUpdateDataError(e As DataAbstractServiceUpdateDataEventArgs)

Parameters:

  • e:

TriggerValidateCommandExecution  protected

 

method TriggerValidateCommandExecution(e: ValidateSchemaObjectAccessEventArgs)

 

void TriggerValidateCommandExecution(ValidateSchemaObjectAccessEventArgs e)

 

Sub TriggerValidateCommandExecution(e As ValidateSchemaObjectAccessEventArgs)

Parameters:

  • e:

TriggerValidateDataTableAccess  protected

 

method TriggerValidateDataTableAccess(e: ValidateSchemaObjectAccessEventArgs)

 

void TriggerValidateDataTableAccess(ValidateSchemaObjectAccessEventArgs e)

 

Sub TriggerValidateDataTableAccess(e As ValidateSchemaObjectAccessEventArgs)

Parameters:

  • e:

TriggerValidateDirectSQLAccess  protected

 

method TriggerValidateDirectSQLAccess(e: ValidateDirectSQLAccessEventArgs)

 

void TriggerValidateDirectSQLAccess(ValidateDirectSQLAccessEventArgs e)

 

Sub TriggerValidateDirectSQLAccess(e As ValidateDirectSQLAccessEventArgs)

Parameters:

  • e:

TriggerValidateRoles  protected    (declared in Service)

Raises the Service event and returns the roles check result.

 

method TriggerValidateRoles(roles: array of String; allowByDefault: Boolean): Boolean

 

Boolean TriggerValidateRoles(String[] roles, Boolean allowByDefault)

 

Function TriggerValidateRoles(roles As String(), allowByDefault As Boolean) As Boolean

Parameters:

  • roles: Required servcie roles
  • allowByDefault: Default result returned when there are no event handlers for the Service event

UnregisterAllBusinessProcessors  protected

 

method UnregisterAllBusinessProcessors

 

void UnregisterAllBusinessProcessors()

 

Sub UnregisterAllBusinessProcessors()

UnregisterBusinessProcessor

 

method UnregisterBusinessProcessor(processor: BusinessProcessor)

 

void UnregisterBusinessProcessor(BusinessProcessor processor)

 

Sub UnregisterBusinessProcessor(processor As BusinessProcessor)

Parameters:

  • processor:

UnregisterForDataChangeNotification

 

method UnregisterForDataChangeNotification(tableName: String)

 

void UnregisterForDataChangeNotification(String tableName)

 

Sub UnregisterForDataChangeNotification(tableName As String)

Parameters:

  • tableName:

UnsubscribeClientEventSink    (declared in Service)

This method unregisters the current client as receiver of the any events.

 

method UnsubscribeClientEventSink

 

void UnsubscribeClientEventSink()

 

Sub UnsubscribeClientEventSink()

UnsubscribeClientEventSink (Type)    (declared in Service)

This method unregisters the current client as receiver of the provided events type.

 

method UnsubscribeClientEventSink(eventSink: Type)

 

void UnsubscribeClientEventSink(Type eventSink)

 

Sub UnsubscribeClientEventSink(eventSink As Type)

Parameters:

  • eventSink: Event sink type

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(serializedDelta: Binary): Binary

 

Binary UpdateData(Binary serializedDelta)

 

Function UpdateData(serializedDelta As Binary) As Binary

Parameters:

  • serializedDelta:

 

AfterAcquireConnection

Occurs after the service has acquired a connection if the AcquireConnection property was set to true. Use this event if you need to perform custom actions on the new connection before the actual data access commences, such as modifying connection properties or running custom commands.

 

event AfterAcquireConnection: ConnectionOperationEventHandler;
delegate:  method AfterAcquireConnection(sender: DataAbstractService; e: ConnectionOperationEventArgs)

 

delegate ConnectionOperationEventHandler AfterAcquireConnection()
delegate:  void AfterAcquireConnection(DataAbstractService sender, ConnectionOperationEventArgs e)

 

Event AfterAcquireConnection As ConnectionOperationEventHandler
delegate:  Sub AfterAcquireConnection(sender As DataAbstractService, e As ConnectionOperationEventArgs)

AfterActivate    (declared in Service)

This event is raised after the service instance has been activated. This event can be used to perform additional service initialization tasks.

 

event AfterActivate: EventHandler<ServiceActivationEventArgs>;

 

delegate EventHandler<ServiceActivationEventArgs> AfterActivate()

 

Event AfterActivate As EventHandler<ServiceActivationEventArgs>

AfterAutoCreateBusinessProcessor

If the AutoCreateBusinessProcessors property is set to true, this event is fired after a business processor has been automatically created. You can use this event to make custom modifications to the created business processor, if needed.

 

event AfterAutoCreateBusinessProcessor: BusinessProcessorAutoCreatedEventHandler;
delegate:  method AfterAutoCreateBusinessProcessor(sender: DataAbstractService; e: BusinessProcessorAutoCreatedEventArgs)

 

delegate BusinessProcessorAutoCreatedEventHandler AfterAutoCreateBusinessProcessor()
delegate:  void AfterAutoCreateBusinessProcessor(DataAbstractService sender, BusinessProcessorAutoCreatedEventArgs e)

 

Event AfterAutoCreateBusinessProcessor As BusinessProcessorAutoCreatedEventHandler
delegate:  Sub AfterAutoCreateBusinessProcessor(sender As DataAbstractService, e As BusinessProcessorAutoCreatedEventArgs)

AfterBeginTransaction

Occurs after the service acquires a connection and begins a transaction. A transaction is automatically started when deltas are being processed by a call to UpdateData. The same transaction is either committed or rolled back at the end of the method call, depending on the delta having been processed successfully or not. You can use the connection's CurrentTransaction property to access the active transaction, for example to configure the transaction.

 

event AfterBeginTransaction: TransactionOperationEventHandler;
delegate:  method AfterBeginTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler AfterBeginTransaction()
delegate:  void AfterBeginTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event AfterBeginTransaction As TransactionOperationEventHandler
delegate:  Sub AfterBeginTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

AfterCommitTransaction

Occurs after the transaction acquired by the UpdateData method has been successfully committed.

 

event AfterCommitTransaction: TransactionOperationEventHandler;
delegate:  method AfterCommitTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler AfterCommitTransaction()
delegate:  void AfterCommitTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event AfterCommitTransaction As TransactionOperationEventHandler
delegate:  Sub AfterCommitTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

AfterDeactivate    (declared in Service)

This event is raised after the service instance has been deactivated. This event can be used to perform additional cleanup tasks.

 

event AfterDeactivate: EventHandler<ServiceActivationEventArgs>;

 

delegate EventHandler<ServiceActivationEventArgs> AfterDeactivate()

 

Event AfterDeactivate As EventHandler<ServiceActivationEventArgs>

AfterExecuteCommand

Occurs after a command was successfully executed using the ExecuteCommand and SqlExecuteCommand methods. You can use this event to inspect the result of the command before it is sent back to the client.

 

event AfterExecuteCommand: DataAbstractServiceExecuteCommandEventHandler;
delegate:  method AfterExecuteCommand(sender: DataAbstractService; e: DataAbstractServiceExecuteCommandEventArgs)

 

delegate DataAbstractServiceExecuteCommandEventHandler AfterExecuteCommand()
delegate:  void AfterExecuteCommand(DataAbstractService sender, DataAbstractServiceExecuteCommandEventArgs e)

 

Event AfterExecuteCommand As DataAbstractServiceExecuteCommandEventHandler
delegate:  Sub AfterExecuteCommand(sender As DataAbstractService, e As DataAbstractServiceExecuteCommandEventArgs)

AfterFindServiceSchema

Occurs the first time the property ServiceSchema is accessed and the schema has been loaded from the resource.

 

event AfterFindServiceSchema: ServiceSchemaOperationEventHandler;
delegate:  method AfterFindServiceSchema(sender: DataAbstractService; e: ServiceSchemaOperationEventArgs)

 

delegate ServiceSchemaOperationEventHandler AfterFindServiceSchema()
delegate:  void AfterFindServiceSchema(DataAbstractService sender, ServiceSchemaOperationEventArgs e)

 

Event AfterFindServiceSchema As ServiceSchemaOperationEventHandler
delegate:  Sub AfterFindServiceSchema(sender As DataAbstractService, e As ServiceSchemaOperationEventArgs)

AfterGetData

Occurs after the service has completed fetching data from the database as part of a call to GetData, and is about to send this data back to the client. You can use this event to perform custom actions after the update, such as updating internal statistics or running custom commands and queries on the database.

 

event AfterGetData: DataAbstractServiceGetDataEventHandler;
delegate:  method AfterGetData(sender: DataAbstractService; e: DataAbstractServiceGetDataEventArgs)

 

delegate DataAbstractServiceGetDataEventHandler AfterGetData()
delegate:  void AfterGetData(DataAbstractService sender, DataAbstractServiceGetDataEventArgs e)

 

Event AfterGetData As DataAbstractServiceGetDataEventHandler
delegate:  Sub AfterGetData(sender As DataAbstractService, e As DataAbstractServiceGetDataEventArgs)

AfterGetSchema

When a remote client requests the ServiceSchema using the remote GetSchema method, this event occurs after the schema has been retrieved, but before it is sent back to the client. Use this event to inspect or modify the XML.

 

event AfterGetSchema: DataAbstractServiceAfterGetSchemaEventHandler;
delegate:  method AfterGetSchema(sender: DataAbstractService; e: DataAbstractServiceAfterGetSchemaEventArgs)

 

delegate DataAbstractServiceAfterGetSchemaEventHandler AfterGetSchema()
delegate:  void AfterGetSchema(DataAbstractService sender, DataAbstractServiceAfterGetSchemaEventArgs e)

 

Event AfterGetSchema As DataAbstractServiceAfterGetSchemaEventHandler
delegate:  Sub AfterGetSchema(sender As DataAbstractService, e As DataAbstractServiceAfterGetSchemaEventArgs)

AfterProcessChange

 

event AfterProcessChange: EventHandler<DeltaChangeEventArgs>;

 

delegate EventHandler<DeltaChangeEventArgs> AfterProcessChange()

 

Event AfterProcessChange As EventHandler<DeltaChangeEventArgs>

AfterProcessDelta

 

event AfterProcessDelta: EventHandler<DeltaEventArgs>;

 

delegate EventHandler<DeltaEventArgs> AfterProcessDelta()

 

Event AfterProcessDelta As EventHandler<DeltaEventArgs>

AfterReleaseConnection

Occurs after the connection that was automatically acquired by the service was released when the service was deactivated.

 

event AfterReleaseConnection: ConnectionOperationEventHandler;
delegate:  method AfterReleaseConnection(sender: DataAbstractService; e: ConnectionOperationEventArgs)

 

delegate ConnectionOperationEventHandler AfterReleaseConnection()
delegate:  void AfterReleaseConnection(DataAbstractService sender, ConnectionOperationEventArgs e)

 

Event AfterReleaseConnection As ConnectionOperationEventHandler
delegate:  Sub AfterReleaseConnection(sender As DataAbstractService, e As ConnectionOperationEventArgs)

AfterRollBackTransaction

Occurs after the transaction that was started by the UpdateData method has been rolled back.

 

event AfterRollBackTransaction: TransactionOperationEventHandler;
delegate:  method AfterRollBackTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler AfterRollBackTransaction()
delegate:  void AfterRollBackTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event AfterRollBackTransaction As TransactionOperationEventHandler
delegate:  Sub AfterRollBackTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

AfterSqlGeneration

 

event AfterSqlGeneration: SqlGenerationEventHandler;
delegate:  method AfterSqlGeneration(sender: BusinessProcessor; e: SqlGenerationEventArgs)

 

delegate SqlGenerationEventHandler AfterSqlGeneration()
delegate:  void AfterSqlGeneration(BusinessProcessor sender, SqlGenerationEventArgs e)

 

Event AfterSqlGeneration As SqlGenerationEventHandler
delegate:  Sub AfterSqlGeneration(sender As BusinessProcessor, e As SqlGenerationEventArgs)

AfterUpdateData

Occurs after the service has completed applying updates to the database as part of a call to UpdateData. You can use this event to perform custom actions after the update, such as updating internal statistics or running custom commands and queries on the database.

 

event AfterUpdateData: DataAbstractServiceUpdateDataEventHandler;
delegate:  method AfterUpdateData(sender: DataAbstractService; e: DataAbstractServiceUpdateDataEventArgs)

 

delegate DataAbstractServiceUpdateDataEventHandler AfterUpdateData()
delegate:  void AfterUpdateData(DataAbstractService sender, DataAbstractServiceUpdateDataEventArgs e)

 

Event AfterUpdateData As DataAbstractServiceUpdateDataEventHandler
delegate:  Sub AfterUpdateData(sender As DataAbstractService, e As DataAbstractServiceUpdateDataEventArgs)

BeforeAcquireConnection

Occurs before a connection is automatically acquired by the service. Use this event to control how connections are acquired if the AcquireConnection property is set to true, for example by dynamically modifying the ConnectionName property.

 

event BeforeAcquireConnection: BeforeAcquireConnectionEventHandler;
delegate:  method BeforeAcquireConnection(sender: DataAbstractService; e: BeforeAcquireConnectionEventArgs)

 

delegate BeforeAcquireConnectionEventHandler BeforeAcquireConnection()
delegate:  void BeforeAcquireConnection(DataAbstractService sender, BeforeAcquireConnectionEventArgs e)

 

Event BeforeAcquireConnection As BeforeAcquireConnectionEventHandler
delegate:  Sub BeforeAcquireConnection(sender As DataAbstractService, e As BeforeAcquireConnectionEventArgs)

BeforeActivate    (declared in Service)

This event is raised before the service instance will be activated. This event can be used to check additional service activation conditions.

 

event BeforeActivate: EventHandler<ServiceActivationEventArgs>;

 

delegate EventHandler<ServiceActivationEventArgs> BeforeActivate()

 

Event BeforeActivate As EventHandler<ServiceActivationEventArgs>

BeforeBeginTransaction

Occurs before a transaction has started during a call to the UpdateData method. Use this event if you need to perform custom configurations or actions on the Connection before the transaction is started.

 

event BeforeBeginTransaction: TransactionOperationEventHandler;
delegate:  method BeforeBeginTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler BeforeBeginTransaction()
delegate:  void BeforeBeginTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event BeforeBeginTransaction As TransactionOperationEventHandler
delegate:  Sub BeforeBeginTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

BeforeCommitTransaction

Occurs when a transaction is about to be committed at the end of a UpdateData method call. You can use the connection's CurrentTransaction property to access the active transaction before it gets committed, for example to configure the transaction or to perform additional database changes.

 

event BeforeCommitTransaction: TransactionOperationEventHandler;
delegate:  method BeforeCommitTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler BeforeCommitTransaction()
delegate:  void BeforeCommitTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event BeforeCommitTransaction As TransactionOperationEventHandler
delegate:  Sub BeforeCommitTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

BeforeDeactivate    (declared in Service)

This event is raised before the service instance will be deactivated. This event can be used to perform additional cleanup tasks.

 

event BeforeDeactivate: EventHandler<ServiceActivationEventArgs>;

 

delegate EventHandler<ServiceActivationEventArgs> BeforeDeactivate()

 

Event BeforeDeactivate As EventHandler<ServiceActivationEventArgs>

BeforeExecuteCommand

Occurs after a command was successfully executed using the ExecuteCommand and SqlExecuteCommand methods. You can use this event to inspect or modify the command before it is executed.

 

event BeforeExecuteCommand: DataAbstractServiceExecuteCommandEventHandler;
delegate:  method BeforeExecuteCommand(sender: DataAbstractService; e: DataAbstractServiceExecuteCommandEventArgs)

 

delegate DataAbstractServiceExecuteCommandEventHandler BeforeExecuteCommand()
delegate:  void BeforeExecuteCommand(DataAbstractService sender, DataAbstractServiceExecuteCommandEventArgs e)

 

Event BeforeExecuteCommand As DataAbstractServiceExecuteCommandEventHandler
delegate:  Sub BeforeExecuteCommand(sender As DataAbstractService, e As DataAbstractServiceExecuteCommandEventArgs)

BeforeExecutingGetDataReader

 

event BeforeExecutingGetDataReader: BeforeExecutingGetDataReaderEventHandler;
delegate:  method BeforeExecutingGetDataReader(sender: ServiceSchema; e: BeforeExecutingGetDataReaderEventArgs)

 

delegate BeforeExecutingGetDataReaderEventHandler BeforeExecutingGetDataReader()
delegate:  void BeforeExecutingGetDataReader(ServiceSchema sender, BeforeExecutingGetDataReaderEventArgs e)

 

Event BeforeExecutingGetDataReader As BeforeExecutingGetDataReaderEventHandler
delegate:  Sub BeforeExecutingGetDataReader(sender As ServiceSchema, e As BeforeExecutingGetDataReaderEventArgs)

BeforeFindServiceSchema

Occurs the first time the property ServiceSchema is accessed and the schema is about to be loaded from the resource. Use this event to manually adjust the ServiceSchemaName before the schema is located.

 

event BeforeFindServiceSchema: BeforeFindServiceSchemaEventHandler;
delegate:  method BeforeFindServiceSchema(sender: DataAbstractService; e: BeforeFindServiceSchemaEventArgs)

 

delegate BeforeFindServiceSchemaEventHandler BeforeFindServiceSchema()
delegate:  void BeforeFindServiceSchema(DataAbstractService sender, BeforeFindServiceSchemaEventArgs e)

 

Event BeforeFindServiceSchema As BeforeFindServiceSchemaEventHandler
delegate:  Sub BeforeFindServiceSchema(sender As DataAbstractService, e As BeforeFindServiceSchemaEventArgs)

BeforeGetData

You can use this event to perform custom actions after the update, such as updating internal statistics or running custom commands and queries on the database.

 

event BeforeGetData: DataAbstractServiceGetDataEventHandler;
delegate:  method BeforeGetData(sender: DataAbstractService; e: DataAbstractServiceGetDataEventArgs)

 

delegate DataAbstractServiceGetDataEventHandler BeforeGetData()
delegate:  void BeforeGetData(DataAbstractService sender, DataAbstractServiceGetDataEventArgs e)

 

Event BeforeGetData As DataAbstractServiceGetDataEventHandler
delegate:  Sub BeforeGetData(sender As DataAbstractService, e As DataAbstractServiceGetDataEventArgs)

BeforeGetSchema

When a remote client requests the ServiceSchema using the remote GetSchema method, this event occurs before the schema is retrieved. Use this event, for example, to allow/prevent Schema access based on session data, or to adjust the ServiceSchemaName before the schema is loaded.

 

event BeforeGetSchema: DataAbstractServiceGetSchemaEventHandler;
delegate:  method BeforeGetSchema(sender: DataAbstractService; e: DataAbstractServiceGetSchemaEventArgs)

 

delegate DataAbstractServiceGetSchemaEventHandler BeforeGetSchema()
delegate:  void BeforeGetSchema(DataAbstractService sender, DataAbstractServiceGetSchemaEventArgs e)

 

Event BeforeGetSchema As DataAbstractServiceGetSchemaEventHandler
delegate:  Sub BeforeGetSchema(sender As DataAbstractService, e As DataAbstractServiceGetSchemaEventArgs)

BeforeGetTableData

 

event BeforeGetTableData: BeforeGetTableDataEventHandler;
delegate:  method BeforeGetTableData(sender: BusinessProcessor; e: BeforeGetTableDataEventArgs)

 

delegate BeforeGetTableDataEventHandler BeforeGetTableData()
delegate:  void BeforeGetTableData(BusinessProcessor sender, BeforeGetTableDataEventArgs e)

 

Event BeforeGetTableData As BeforeGetTableDataEventHandler
delegate:  Sub BeforeGetTableData(sender As BusinessProcessor, e As BeforeGetTableDataEventArgs)

BeforeProcessChange

 

event BeforeProcessChange: EventHandler<DeltaChangeEventArgs>;

 

delegate EventHandler<DeltaChangeEventArgs> BeforeProcessChange()

 

Event BeforeProcessChange As EventHandler<DeltaChangeEventArgs>

BeforeProcessDelta

 

event BeforeProcessDelta: EventHandler<DeltaEventArgs>;

 

delegate EventHandler<DeltaEventArgs> BeforeProcessDelta()

 

Event BeforeProcessDelta As EventHandler<DeltaEventArgs>

BeforeReleaseConnection

Occurs before the connection that was automatically acquired by the service is released and the service is being deactivated. Use this event if you need to perform custom actions on the connection after the actual data access has completed, for example running custom commands or logging access statistics.

 

event BeforeReleaseConnection: ConnectionOperationEventHandler;
delegate:  method BeforeReleaseConnection(sender: DataAbstractService; e: ConnectionOperationEventArgs)

 

delegate ConnectionOperationEventHandler BeforeReleaseConnection()
delegate:  void BeforeReleaseConnection(DataAbstractService sender, ConnectionOperationEventArgs e)

 

Event BeforeReleaseConnection As ConnectionOperationEventHandler
delegate:  Sub BeforeReleaseConnection(sender As DataAbstractService, e As ConnectionOperationEventArgs)

BeforeRollBackTransaction

Occurs before the transaction that was begun by the UpdateData method is about to be rolled back. You can use the connection's CurrentTransaction property to access the active transaction before it gets rolled back, for example to configure the transaction or to perform additional database changes.

 

event BeforeRollBackTransaction: TransactionOperationEventHandler;
delegate:  method BeforeRollBackTransaction(sender: DataAbstractService; e: TransactionOperationEventArgs)

 

delegate TransactionOperationEventHandler BeforeRollBackTransaction()
delegate:  void BeforeRollBackTransaction(DataAbstractService sender, TransactionOperationEventArgs e)

 

Event BeforeRollBackTransaction As TransactionOperationEventHandler
delegate:  Sub BeforeRollBackTransaction(sender As DataAbstractService, e As TransactionOperationEventArgs)

BeforeUpdateData

Occurs before the service starts applying updates to the database as part of a call to UpdateData. You can use this event to perform custom actions before the update, such as updating internal statistics or running custom commands and queries on the database.

 

event BeforeUpdateData: DataAbstractServiceUpdateDataEventHandler;
delegate:  method BeforeUpdateData(sender: DataAbstractService; e: DataAbstractServiceUpdateDataEventArgs)

 

delegate DataAbstractServiceUpdateDataEventHandler BeforeUpdateData()
delegate:  void BeforeUpdateData(DataAbstractService sender, DataAbstractServiceUpdateDataEventArgs e)

 

Event BeforeUpdateData As DataAbstractServiceUpdateDataEventHandler
delegate:  Sub BeforeUpdateData(sender As DataAbstractService, e As DataAbstractServiceUpdateDataEventArgs)

ProcessError

 

event ProcessError: EventHandler<DeltaChangeErrorEventArgs>;

 

delegate EventHandler<DeltaChangeErrorEventArgs> ProcessError()

 

Event ProcessError As EventHandler<DeltaChangeErrorEventArgs>

ServiceActivationException    (declared in Service)

 

event ServiceActivationException: EventHandler<ServiceActivationExceptionEventArgs>;

 

delegate EventHandler<ServiceActivationExceptionEventArgs> ServiceActivationException()

 

Event ServiceActivationException As EventHandler<ServiceActivationExceptionEventArgs>

ServiceMethodException    (declared in Service)

 

event ServiceMethodException: EventHandler<ServiceMethodExceptionEventArgs>;

 

delegate EventHandler<ServiceMethodExceptionEventArgs> ServiceMethodException()

 

Event ServiceMethodException As EventHandler<ServiceMethodExceptionEventArgs>

UnknownSqlMacroIdentifier

Fires when unknown macro variable is found. it can be usable when user-defined variables are used inside sql or Dynamic Where expression.

 

event UnknownSqlMacroIdentifier: EventHandler<CustomSqlMacroEventArgs>;

 

delegate EventHandler<CustomSqlMacroEventArgs> UnknownSqlMacroIdentifier()

 

Event UnknownSqlMacroIdentifier As EventHandler<CustomSqlMacroEventArgs>

UpdateDataError

Occurs if errors are encountered while applying updates to the database as part of a call to UpdateData. You can use this event to perform custom actions before handling the errors.

 

event UpdateDataError: DataAbstractServiceUpdateDataEventHandler;
delegate:  method UpdateDataError(sender: DataAbstractService; e: DataAbstractServiceUpdateDataEventArgs)

 

delegate DataAbstractServiceUpdateDataEventHandler UpdateDataError()
delegate:  void UpdateDataError(DataAbstractService sender, DataAbstractServiceUpdateDataEventArgs e)

 

Event UpdateDataError As DataAbstractServiceUpdateDataEventHandler
delegate:  Sub UpdateDataError(sender As DataAbstractService, e As DataAbstractServiceUpdateDataEventArgs)

ValidateCommandExecution

 

event ValidateCommandExecution: EventHandler<ValidateSchemaObjectAccessEventArgs>;

 

delegate EventHandler<ValidateSchemaObjectAccessEventArgs> ValidateCommandExecution()

 

Event ValidateCommandExecution As EventHandler<ValidateSchemaObjectAccessEventArgs>

ValidateDataTableAccess

 

event ValidateDataTableAccess: EventHandler<ValidateSchemaObjectAccessEventArgs>;

 

delegate EventHandler<ValidateSchemaObjectAccessEventArgs> ValidateDataTableAccess()

 

Event ValidateDataTableAccess As EventHandler<ValidateSchemaObjectAccessEventArgs>

ValidateDirectSQLAccess

 

event ValidateDirectSQLAccess: EventHandler<ValidateDirectSQLAccessEventArgs>;

 

delegate EventHandler<ValidateDirectSQLAccessEventArgs> ValidateDirectSQLAccess()

 

Event ValidateDirectSQLAccess As EventHandler<ValidateDirectSQLAccessEventArgs>

ValidateRoles    (declared in Service)

This event is triggered for methods that have roles set and can be used to override the default roles check procedure.

 

event ValidateRoles: EventHandler<ValidateRolesEventArgs>;

 

delegate EventHandler<ValidateRolesEventArgs> ValidateRoles()

 

Event ValidateRoles As EventHandler<ValidateRolesEventArgs>