MultiDbLoginServiceV5 Class

From RemObjects Wiki
Jump to: navigation, search

This is a Library topic for Data Abstract for .NET
This page is generated from external data, please do not update

Namespaces — Interfaces — Classes — Enums — Implements

Contents

Overview

This class implements the MultiDbLoginServiceV5 service defined in the DataAbstract for .NET framework. The MultiDbLoginServiceV5 class extends the MultiDbLoginService by adding several methods that allow to get information about database connections defined at the server side.

The MultiDbLoginServiceV5 service type can be used if you need to provide information about defined connections at the client side.


Location


Properties

AcquireConnection     (declared in DataAbstractService)

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.



Prism:   property AcquireConnection: Boolean read write
C#:   Boolean AcquireConnection { get; set; }
VB:   Property AcquireConnection As Boolean


AllowDataAccess     (declared in DataAbstractService)

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



Prism:   property AllowDataAccess: Boolean read write
C#:   Boolean AllowDataAccess { get; set; }
VB:   Property AllowDataAccess As Boolean


AllowDynamicSelect     (declared in DataAbstractService)



Prism:   property AllowDynamicSelect: Boolean read write
C#:   Boolean AllowDynamicSelect { get; set; }
VB:   Property AllowDynamicSelect As Boolean


AllowDynamicWhere     (declared in DataAbstractService)

Allows clients to use Dynamic Where feature.



Prism:   property AllowDynamicWhere: Boolean read write
C#:   Boolean AllowDynamicWhere { get; set; }
VB:   Property AllowDynamicWhere As Boolean


AllowExecuteCommands     (declared in DataAbstractService)

Determines if the ExecuteCommand and SqlExecuteCommand methods can be invoked from the client side.

Note: This property exist to prevent the execution of arbitrary SQL statements by clients and is set to false by default. When setting this property to true, be aware that any client authorized to call methods on your service is capable of running commands published in your schema and running custom SQL commands.



Prism:   property AllowExecuteCommands: Boolean read write
C#:   Boolean AllowExecuteCommands { get; set; }
VB:   Property AllowExecuteCommands As Boolean


AllowExecuteDASQL     (declared in DataAbstractService)



Prism:   property AllowExecuteDASQL: Boolean read write
C#:   Boolean AllowExecuteDASQL { get; set; }
VB:   Property AllowExecuteDASQL As Boolean


AllowExecuteSQL     (declared in DataAbstractService)

Allows clients to execute custom SQL as command or for retrieving data from the published schema (true) or not (false, default). Since enabling this option opens a huge security risk, this property is set to false by default.

If enabled, client applications can send custom SQL text to the server for execution, including code that could potentially harm or destroy the database.

Even when using proper user authentication and trusting the client applications, this is a high security risk, as client applications could be modified to send malicious code, or a new client could be written by attackers.



Prism:   property AllowExecuteSQL: Boolean read write
C#:   Boolean AllowExecuteSQL { get; set; }
VB:   Property AllowExecuteSQL As Boolean


AllowHttpSchemaAccess     (declared in DataAbstractService)

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.



Prism:   property AllowHttpSchemaAccess: Boolean read write
C#:   Boolean AllowHttpSchemaAccess { get; set; }
VB:   Property AllowHttpSchemaAccess As Boolean


AllowSchemaAccess     (declared in DataAbstractService)

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.



Prism:   property AllowSchemaAccess: Boolean read write
C#:   Boolean AllowSchemaAccess { get; set; }
VB:   Property AllowSchemaAccess As Boolean


AllowUpdates     (declared in DataAbstractService)



Prism:   property AllowUpdates: Boolean read write
C#:   Boolean AllowUpdates { get; set; }
VB:   Property AllowUpdates As Boolean


AutoCreateBusinessProcessors     (declared in DataAbstractService)

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.



Prism:   property AutoCreateBusinessProcessors: Boolean read write
C#:   Boolean AutoCreateBusinessProcessors { get; set; }
VB:   Property AutoCreateBusinessProcessors As Boolean


BusinessProcessors     (declared in DataAbstractService)

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.



Prism:   property BusinessProcessors: NamedObjectCollection<BusinessProcessor> read
C#:   NamedObjectCollection<BusinessProcessor> BusinessProcessors { get; }
VB:   Property ReadOnly BusinessProcessors As NamedObjectCollection<BusinessProcessor>


CanBeDisposed     (declared in Service)

Specifies whether your service instance can be disposed after servicing the current request (true) or not (false).



Prism:   property CanBeDisposed: Boolean read
C#:   Boolean CanBeDisposed { get; }
VB:   Property ReadOnly CanBeDisposed As Boolean


Connection     (declared in DataAbstractService)

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



Prism:   property Connection: IAbstractConnection read write
C#:   IAbstractConnection Connection { get; set; }
VB:   Property Connection As IAbstractConnection


ConnectionName     (declared in DataAbstractService)

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.



Prism:   property ConnectionName: String read write
C#:   String ConnectionName { get; set; }
VB:   Property ConnectionName As String


DASqlProcessor     (declared in DataAbstractService)



Prism:   property DASqlProcessor: DASqlProcessor read write
C#:   DASqlProcessor DASqlProcessor { get; set; }
VB:   Property DASqlProcessor As DASqlProcessor


HasSession     (declared in Service)



Prism:   property HasSession: Boolean read
C#:   Boolean HasSession { get; }
VB:   Property ReadOnly HasSession As Boolean


IsAbstract     (declared in Service)



Prism:   property IsAbstract: Boolean read write
C#:   Boolean IsAbstract { get; set; }
VB:   Property IsAbstract As Boolean


ProcessAllDeltas     (declared in DataAbstractService)

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



Prism:   property ProcessAllDeltas: Boolean read write
C#:   Boolean ProcessAllDeltas { get; set; }
VB:   Property ProcessAllDeltas As Boolean


RequireSession     (declared in Service)

Set this property to true to indicate that this service may only be accessed if a session already exists.



Prism:   property RequireSession: Boolean read write
C#:   Boolean RequireSession { get; set; }
VB:   Property RequireSession As Boolean


ScriptProvider     (declared in DataAbstractService)



Prism:   property ScriptProvider: IScriptProvider read write
C#:   IScriptProvider ScriptProvider { get; set; }
VB:   Property ScriptProvider As IScriptProvider


ServerChannel     (declared in Service)

Implement this property to receive a reference to the IServerChannelInfo for the request served by your service.



Prism:   property ServerChannel: IServerChannelInfo read
C#:   IServerChannelInfo ServerChannel { get; }
VB:   Property ReadOnly ServerChannel As IServerChannelInfo


ServiceDataStreamer     (declared in DataAbstractService)

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



Prism:   property ServiceDataStreamer: DataStreamer read write
C#:   DataStreamer ServiceDataStreamer { get; set; }
VB:   Property ServiceDataStreamer As DataStreamer


ServiceSchema     (declared in DataAbstractService)

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



Prism:   property ServiceSchema: ServiceSchema read
C#:   ServiceSchema ServiceSchema { get; }
VB:   Property ReadOnly ServiceSchema As ServiceSchema


ServiceSchemaName     (declared in DataAbstractService)

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



Prism:   property ServiceSchemaName: String read write
C#:   String ServiceSchemaName { get; set; }
VB:   Property ServiceSchemaName As String


Session     (declared in Service)

Provides access to the Session object for the current session. If no session exists for the current client yet, a new session will be created when the Session property is accessed (but not before). Note: Session returns null if no Session Manager is available. To make Session Management available, a SessionManager descendant component must be dropped on your main form (otherwise it is created at startup of your server).



Prism:   property Session: ISession read write
C#:   ISession Session { get; set; }
VB:   Property Session As ISession


SessionID     (declared in Service)

Stores the SessionID (aka ClientID) of the request that is currently being executed. If you are not using the session management architecture (which handles this for you, also based on the SessionID), you can use this ID to match calls to certain clients or to customize the persistence of client-specific data.



Prism:   property SessionID: Guid read
C#:   Guid SessionID { get; }
VB:   Property ReadOnly SessionID As Guid


SessionManager   protected     (declared in Service)



Prism:   property SessionManager: SessionManager read
C#:   SessionManager SessionManager { get; }
VB:   Property ReadOnly SessionManager As SessionManager


Class Methods

BuildParameters   protected     (declared in DataAbstractService)



Oxygene:   class method BuildParameters(aReq: SimpleRequestInfo): array of DataParameter
C#:   static array of DataParameter BuildParameters(SimpleRequestInfo aReq)
VB:   Shared Function BuildParameters(aReq As SimpleRequestInfo) As array of DataParameter


Parameters:

  • aReq:


Instance Methods

constructor

Creates a new instance of the MultiDbLoginServiceV5 class.


Oxygene:   constructor
C#:   constructor()
VB:   Sub New


Activate     (declared in DataAbstractService)



Oxygene:   method Activate(aSessionID: Guid)
C#:   void Activate(Guid aSessionID)
VB:   Sub Activate(aSessionID As Guid)


Parameters:

  • aSessionID:


BeginTransaction   protected     (declared in DataAbstractService)



Oxygene:   method BeginTransaction(var connection: IAbstractConnection): Int32
C#:   Int32 BeginTransaction(ref IAbstractConnection connection)
VB:   Function BeginTransaction(ByRef connection As IAbstractConnection) As Int32


Parameters:

  • connection:


CheckConnection   protected     (declared in DataAbstractService)



Oxygene:   method CheckConnection
C#:   void CheckConnection()
VB:   Sub CheckConnection


CommitTransaction   protected     (declared in DataAbstractService)



Oxygene:   method CommitTransaction(connection: IAbstractConnection)
C#:   void CommitTransaction(IAbstractConnection connection)
VB:   Sub CommitTransaction(connection As IAbstractConnection)


Parameters:

  • connection:


Deactivate     (declared in DataAbstractService)



Oxygene:   method Deactivate(aSessionID: Guid)
C#:   void Deactivate(Guid aSessionID)
VB:   Sub Deactivate(aSessionID As Guid)


Parameters:

  • aSessionID:


DestroySession   protected     (declared in Service)



Oxygene:   method DestroySession
C#:   void DestroySession()
VB:   Sub DestroySession


Dispose   protected

Releases unmanaged resources used by the current instance.


Oxygene:   method Dispose(disposing: Boolean)
C#:   void Dispose(Boolean disposing)
VB:   Sub Dispose(disposing As Boolean)


Parameters:

  • disposing:


DropConnection   protected     (declared in DataAbstractService)



Oxygene:   method DropConnection(aConnection: IAbstractConnection)
C#:   void DropConnection(IAbstractConnection aConnection)
VB:   Sub DropConnection(aConnection As IAbstractConnection)


Parameters:

  • aConnection:


ExecuteCommand     (declared in DataAbstractService)

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.


Oxygene:   method ExecuteCommand(commandName: String; parameters: array of DataParameter): Int32
C#:   Int32 ExecuteCommand(String commandName, array of DataParameter parameters)
VB:   Function ExecuteCommand(commandName As String, parameters As array of DataParameter) As Int32


Parameters:

  • commandName:
  • parameters:


ExecuteCommandEx     (declared in DataAbstractService)



Oxygene:   method ExecuteCommandEx(commandName: String; inputParameters: array of DataParameter; out outputParameters: array of DataParameter): Int32
C#:   Int32 ExecuteCommandEx(String commandName, array of DataParameter inputParameters, out array of DataParameter outputParameters)
VB:   Function ExecuteCommandEx(commandName As String, inputParameters As array of DataParameter, <OutAttribute> ByRef outputParameters As array of DataParameter) As Int32


Parameters:

  • commandName:
  • inputParameters:
  • outputParameters:


GetBusinessProcessor   protected     (declared in DataAbstractService)



Oxygene:   method GetBusinessProcessor(tableName: String; createIfNeeded: Boolean): BusinessProcessor
C#:   BusinessProcessor GetBusinessProcessor(String tableName, Boolean createIfNeeded)
VB:   Function GetBusinessProcessor(tableName As String, createIfNeeded As Boolean) As BusinessProcessor


Parameters:

  • tableName:
  • createIfNeeded:


GetCommandSchema     (declared in DataAbstractService)

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


Oxygene:   method GetCommandSchema(commandNames: array of String): String
C#:   String GetCommandSchema(array of String commandNames)
VB:   Function GetCommandSchema(commandNames As array of String) As String


Parameters:

  • commandNames:


GetConnection   protected     (declared in DataAbstractService)



Oxygene:   method GetConnection: IAbstractConnection
C#:   IAbstractConnection GetConnection()
VB:   Function GetConnection As IAbstractConnection


GetConnectionNames

Gets the names of the connections defined in the default ConnectionManager instance.


Oxygene:   method GetConnectionNames: array of String
C#:   array of String GetConnectionNames()
VB:   Function GetConnectionNames As array of String


GetData     (declared in DataAbstractService)

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.


Oxygene:   method GetData(tableNames: array of String; requestInfo: array of TableRequestInfo): Binary
C#:   Binary GetData(array of String tableNames, array of TableRequestInfo requestInfo)
VB:   Function GetData(tableNames As array of String, requestInfo As array of TableRequestInfo) As Binary


Parameters:

  • tableNames:
  • requestInfo:


GetDatasetScripts     (declared in DataAbstractService)



Oxygene:   method GetDatasetScripts(tableNames: String): String
C#:   String GetDatasetScripts(String tableNames)
VB:   Function GetDatasetScripts(tableNames As String) As String


Parameters:

  • tableNames:


GetDefaultConnectionName

Gets the name of the connection marked as default defined in the ConnectionManager instance registered as default ConnectionManager.


Oxygene:   method GetDefaultConnectionName: String
C#:   String GetDefaultConnectionName()
VB:   Function GetDefaultConnectionName As String


GetDetailDeltas   protected     (declared in DataAbstractService)



Oxygene:   method GetDetailDeltas(master: Delta; deltas: NamedObjectCollection<Delta>): NamedObjectCollection<Delta>
C#:   NamedObjectCollection<Delta> GetDetailDeltas(Delta master, NamedObjectCollection<Delta> deltas)
VB:   Function GetDetailDeltas(master As Delta, deltas As NamedObjectCollection<Delta>) As NamedObjectCollection<Delta>


Parameters:

  • master:
  • deltas:


GetEventSink (): T     (declared in Service)

Obtains an event sink proxy for the specified interface. The result value can be cast back to the event sink interface in question and then be used to call the event sink's methods. The event calls will be encoded using the Message assigned to the global EventSinkManager and then queued in the global MessageQueueManager.


Oxygene:   method GetEventSink: T
C#:   T GetEventSink()
VB:   Function GetEventSink As T


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



Oxygene:   method GetEventSink(recipients: array of Guid): T
C#:   T GetEventSink(array of Guid recipients)
VB:   Function GetEventSink(recipients As array of Guid) As T


Parameters:

  • recipients:


GetEventSink (IEventTargets): T     (declared in Service)



Oxygene:   method GetEventSink(eventTargets: IEventTargets): T
C#:   T GetEventSink(IEventTargets eventTargets)
VB:   Function GetEventSink(eventTargets As IEventTargets) As T


Parameters:

  • eventTargets:


GetEventSink (Type): IROEventSink     (declared in Service)



Oxygene:   method GetEventSink(eventSink: Type): IROEventSink
C#:   IROEventSink GetEventSink(Type eventSink)
VB:   Function GetEventSink(eventSink As Type) As IROEventSink


Parameters:

  • eventSink:


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



Oxygene:   method GetEventSink(eventSink: Type; recipients: array of Guid): IROEventSink
C#:   IROEventSink GetEventSink(Type eventSink, array of Guid recipients)
VB:   Function GetEventSink(eventSink As Type, recipients As array of Guid) As IROEventSink


Parameters:

  • eventSink:
  • recipients:


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



Oxygene:   method GetEventSink(eventSink: Type; eventTargets: IEventTargets): IROEventSink
C#:   IROEventSink GetEventSink(Type eventSink, IEventTargets eventTargets)
VB:   Function GetEventSink(eventSink As Type, eventTargets As IEventTargets) As IROEventSink


Parameters:

  • eventSink:
  • eventTargets:


GetSchema     (declared in DataAbstractService)

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


Oxygene:   method GetSchema(filter: String): String
C#:   String GetSchema(String filter)
VB:   Function GetSchema(filter As String) As String


Parameters:

  • filter:


GetScriptContext   protected     (declared in DataAbstractService)



Oxygene:   method GetScriptContext: IServerScriptContext
C#:   IServerScriptContext GetScriptContext()
VB:   Function GetScriptContext As IServerScriptContext


GetScriptDebugger   protected     (declared in DataAbstractService)



Oxygene:   method GetScriptDebugger: IScriptDebugger
C#:   IScriptDebugger GetScriptDebugger()
VB:   Function GetScriptDebugger As IScriptDebugger


GetSession   protected     (declared in Service)



Oxygene:   method GetSession: ISession
C#:   ISession GetSession()
VB:   Function GetSession As ISession


GetTableSchema     (declared in DataAbstractService)

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


Oxygene:   method GetTableSchema(tableNames: array of String): String
C#:   String GetTableSchema(array of String tableNames)
VB:   Function GetTableSchema(tableNames As array of String) As String


Parameters:

  • tableNames:


InitializeScriptProvider   protected     (declared in DataAbstractService)



Oxygene:   method InitializeScriptProvider
C#:   void InitializeScriptProvider()
VB:   Sub InitializeScriptProvider


InitializeServiceSchema   protected     (declared in DataAbstractService)



Oxygene:   method InitializeServiceSchema
C#:   void InitializeServiceSchema()
VB:   Sub InitializeServiceSchema


InitializeServiceSchemaAndScriptProvider     (declared in DataAbstractService)



Oxygene:   method InitializeServiceSchemaAndScriptProvider(aIgnoreCache: Boolean)
C#:   void InitializeServiceSchemaAndScriptProvider(Boolean aIgnoreCache)
VB:   Sub InitializeServiceSchemaAndScriptProvider(aIgnoreCache As Boolean)


Parameters:

  • aIgnoreCache:


Login     (declared in MultiDbLoginService)



Oxygene:   method Login(username: String; password: String; connectionName: String; out userInfo: UserInfo): Boolean
C#:   Boolean Login(String username, String password, String connectionName, out UserInfo userInfo)
VB:   Function Login(username As String, password As String, connectionName As String, <OutAttribute> ByRef userInfo As UserInfo) As Boolean


Parameters:

  • username:
  • password:
  • connectionName:
  • userInfo:


LoginEx     (declared in MultiDbLoginService)



Oxygene:   method LoginEx(loginString: String): Boolean
C#:   Boolean LoginEx(String loginString)
VB:   Function LoginEx(loginString As String) As Boolean


Parameters:

  • loginString:


Logout     (declared in BaseLoginService)



Oxygene:   method Logout
C#:   void Logout()
VB:   Sub Logout


OnExecuteLogin   protected     (declared in MultiDbLoginService)



Oxygene:   method OnExecuteLogin(e: MultiDbLoginEventArgs)
C#:   void OnExecuteLogin(MultiDbLoginEventArgs e)
VB:   Sub OnExecuteLogin(e As MultiDbLoginEventArgs)


Parameters:

  • e:


PackDeltas   protected     (declared in DataAbstractService)



Oxygene:   method PackDeltas(streamer: DataStreamer; deltas: NamedObjectCollection<Delta>): Binary
C#:   Binary PackDeltas(DataStreamer streamer, NamedObjectCollection<Delta> deltas)
VB:   Function PackDeltas(streamer As DataStreamer, deltas As NamedObjectCollection<Delta>) As Binary


Parameters:

  • streamer:
  • deltas:


ProcessDelta   protected     (declared in DataAbstractService)



Oxygene:   method ProcessDelta(delta: Delta; processDeletes: Boolean; processInserts: Boolean; processUpdates: Boolean; detailDeltas: NamedObjectCollection<Delta>)
C#:   void ProcessDelta(Delta delta, Boolean processDeletes, Boolean processInserts, Boolean processUpdates, NamedObjectCollection<Delta> detailDeltas)
VB:   Sub ProcessDelta(delta As Delta, processDeletes As Boolean, processInserts As Boolean, processUpdates As Boolean, detailDeltas As NamedObjectCollection<Delta>)


Parameters:

  • delta:
  • processDeletes:
  • processInserts:
  • processUpdates:
  • detailDeltas:


RegisterAllBusinessProcessors   protected     (declared in DataAbstractService)



Oxygene:   method RegisterAllBusinessProcessors
C#:   void RegisterAllBusinessProcessors()
VB:   Sub RegisterAllBusinessProcessors


RegisterBusinessProcessor   protected     (declared in DataAbstractService)



Oxygene:   method RegisterBusinessProcessor(aBusinessProcessor: BusinessProcessor)
C#:   void RegisterBusinessProcessor(BusinessProcessor aBusinessProcessor)
VB:   Sub RegisterBusinessProcessor(aBusinessProcessor As BusinessProcessor)


Parameters:

  • aBusinessProcessor:


RegisterForDataChangeNotification     (declared in DataAbstractService)



Oxygene:   method RegisterForDataChangeNotification(tableName: String)
C#:   void RegisterForDataChangeNotification(String tableName)
VB:   Sub RegisterForDataChangeNotification(tableName As String)


Parameters:

  • tableName:


ReleaseConnection   protected     (declared in DataAbstractService)



Oxygene:   method ReleaseConnection(aConnection: IAbstractConnection)
C#:   void ReleaseConnection(IAbstractConnection aConnection)
VB:   Sub ReleaseConnection(aConnection As IAbstractConnection)


Parameters:

  • aConnection:


ReloadScript     (declared in DataAbstractService)



Oxygene:   method ReloadScript
C#:   void ReloadScript()
VB:   Sub ReloadScript


RollbackTransaction   protected     (declared in DataAbstractService)



Oxygene:   method RollbackTransaction(connection: IAbstractConnection)
C#:   void RollbackTransaction(IAbstractConnection connection)
VB:   Sub RollbackTransaction(connection As IAbstractConnection)


Parameters:

  • connection:


ServiceValidateRoles     (declared in Service)



Oxygene:   method ServiceValidateRoles(requiredRoles: array of String)
C#:   void ServiceValidateRoles(array of String requiredRoles)
VB:   Sub ServiceValidateRoles(requiredRoles As array of String)


Parameters:

  • requiredRoles:


SetupDASqlProcessor   protected     (declared in DataAbstractService)



Oxygene:   method SetupDASqlProcessor
C#:   void SetupDASqlProcessor()
VB:   Sub SetupDASqlProcessor


SimpleGetData     (declared in DataAbstractService)



Oxygene:   method SimpleGetData(requestInfo: array of SimpleRequestInfo): array of SimpleDataResult
C#:   array of SimpleDataResult SimpleGetData(array of SimpleRequestInfo requestInfo)
VB:   Function SimpleGetData(requestInfo As array of SimpleRequestInfo) As array of SimpleDataResult


Parameters:

  • requestInfo:


SimpleUpdateData     (declared in DataAbstractService)



Oxygene:   method SimpleUpdateData(delta: array of SimpleDelta): array of SimpleDelta
C#:   array of SimpleDelta SimpleUpdateData(array of SimpleDelta delta)
VB:   Function SimpleUpdateData(delta As array of SimpleDelta) As array of SimpleDelta


Parameters:

  • delta:


SQLExecuteCommand     (declared in DataAbstractService)

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

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


Oxygene:   method SQLExecuteCommand(sql: String): Int32
C#:   Int32 SQLExecuteCommand(String sql)
VB:   Function SQLExecuteCommand(sql As String) As Int32


Parameters:

  • sql:


SQLExecuteCommandEx     (declared in DataAbstractService)



Oxygene:   method SQLExecuteCommandEx(sql: String; dynamicWhere: String): Int32
C#:   Int32 SQLExecuteCommandEx(String sql, String dynamicWhere)
VB:   Function SQLExecuteCommandEx(sql As String, dynamicWhere As String) As Int32


Parameters:

  • sql:
  • dynamicWhere:


SQLGetData     (declared in DataAbstractService)

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

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


Oxygene:   method SQLGetData(sql: String; includeSchema: Boolean; maxRecords: Int32): Binary
C#:   Binary SQLGetData(String sql, Boolean includeSchema, Int32 maxRecords)
VB:   Function SQLGetData(sql As String, includeSchema As Boolean, maxRecords As Int32) As Binary


Parameters:

  • sql:
  • includeSchema:
  • maxRecords:


SQLGetDataEx     (declared in DataAbstractService)



Oxygene:   method SQLGetDataEx(sql: String; includeSchema: Boolean; maxRecords: Int32; dynamicWhere: String): Binary
C#:   Binary SQLGetDataEx(String sql, Boolean includeSchema, Int32 maxRecords, String dynamicWhere)
VB:   Function SQLGetDataEx(sql As String, includeSchema As Boolean, maxRecords As Int32, dynamicWhere As String) As Binary


Parameters:

  • sql:
  • includeSchema:
  • maxRecords:
  • dynamicWhere:


SubscribeClientEventSink     (declared in Service)

This method will subscribe the current client to the passed event sink. The client will receive events for all future calls into the event sink (by the current service, or all other services implemented in the same server application).


Oxygene:   method SubscribeClientEventSink(eventSink: Type)
C#:   void SubscribeClientEventSink(Type eventSink)
VB:   Sub SubscribeClientEventSink(eventSink As Type)


Parameters:

  • eventSink:


SynchronizeMasterDetailFields   protected     (declared in DataAbstractService)



Oxygene:   method SynchronizeMasterDetailFields(master: Delta; details: NamedObjectCollection<Delta>)
C#:   void SynchronizeMasterDetailFields(Delta master, NamedObjectCollection<Delta> details)
VB:   Sub SynchronizeMasterDetailFields(master As Delta, details As NamedObjectCollection<Delta>)


Parameters:

  • master:
  • details:


TriggerAfterAcquireConnection   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterAcquireConnection(e: ConnectionOperationEventArgs)
C#:   void TriggerAfterAcquireConnection(ConnectionOperationEventArgs e)
VB:   Sub TriggerAfterAcquireConnection(e As ConnectionOperationEventArgs)


Parameters:

  • e:


TriggerAfterActivate   protected     (declared in Service)



Oxygene:   method TriggerAfterActivate(sessionId: Guid)
C#:   void TriggerAfterActivate(Guid sessionId)
VB:   Sub TriggerAfterActivate(sessionId As Guid)


Parameters:

  • sessionId:


TriggerAfterAutoCreateBusinessProcessor   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterAutoCreateBusinessProcessor(e: BusinessProcessorAutoCreatedEventArgs)
C#:   void TriggerAfterAutoCreateBusinessProcessor(BusinessProcessorAutoCreatedEventArgs e)
VB:   Sub TriggerAfterAutoCreateBusinessProcessor(e As BusinessProcessorAutoCreatedEventArgs)


Parameters:

  • e:


TriggerAfterBeginTransaction   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterBeginTransaction(e: TransactionOperationEventArgs)
C#:   void TriggerAfterBeginTransaction(TransactionOperationEventArgs e)
VB:   Sub TriggerAfterBeginTransaction(e As TransactionOperationEventArgs)


Parameters:

  • e:


TriggerAfterCommitTransaction   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterCommitTransaction(e: TransactionOperationEventArgs)
C#:   void TriggerAfterCommitTransaction(TransactionOperationEventArgs e)
VB:   Sub TriggerAfterCommitTransaction(e As TransactionOperationEventArgs)


Parameters:

  • e:


TriggerAfterDeactivate   protected     (declared in Service)



Oxygene:   method TriggerAfterDeactivate(sessionId: Guid)
C#:   void TriggerAfterDeactivate(Guid sessionId)
VB:   Sub TriggerAfterDeactivate(sessionId As Guid)


Parameters:

  • sessionId:


TriggerAfterExecuteCommand (DataAbstractServiceExecuteCommandEventArgs)   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterExecuteCommand(e: DataAbstractServiceExecuteCommandEventArgs)
C#:   void TriggerAfterExecuteCommand(DataAbstractServiceExecuteCommandEventArgs e)
VB:   Sub TriggerAfterExecuteCommand(e As DataAbstractServiceExecuteCommandEventArgs)


Parameters:

  • e:


TriggerAfterExecuteCommand (ExecuteCommandArgs)   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterExecuteCommand(e: ExecuteCommandArgs)
C#:   void TriggerAfterExecuteCommand(ExecuteCommandArgs e)
VB:   Sub TriggerAfterExecuteCommand(e As ExecuteCommandArgs)


Parameters:

  • e:


TriggerAfterFindServiceSchema   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterFindServiceSchema(e: ServiceSchemaOperationEventArgs)
C#:   void TriggerAfterFindServiceSchema(ServiceSchemaOperationEventArgs e)
VB:   Sub TriggerAfterFindServiceSchema(e As ServiceSchemaOperationEventArgs)


Parameters:

  • e:


TriggerAfterGetCommandSchema   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterGetCommandSchema(e: DataAbstractServiceGetCommandSchemaEventArgs)
C#:   void TriggerAfterGetCommandSchema(DataAbstractServiceGetCommandSchemaEventArgs e)
VB:   Sub TriggerAfterGetCommandSchema(e As DataAbstractServiceGetCommandSchemaEventArgs)


Parameters:

  • e:


TriggerAfterGetData   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterGetData(e: DataAbstractServiceGetDataEventArgs)
C#:   void TriggerAfterGetData(DataAbstractServiceGetDataEventArgs e)
VB:   Sub TriggerAfterGetData(e As DataAbstractServiceGetDataEventArgs)


Parameters:

  • e:


TriggerAfterGetSchema   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterGetSchema(e: DataAbstractServiceAfterGetSchemaEventArgs)
C#:   void TriggerAfterGetSchema(DataAbstractServiceAfterGetSchemaEventArgs e)
VB:   Sub TriggerAfterGetSchema(e As DataAbstractServiceAfterGetSchemaEventArgs)


Parameters:

  • e:


TriggerAfterGetTableSchema   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterGetTableSchema(e: DataAbstractServiceGetTableSchemaEventArgs)
C#:   void TriggerAfterGetTableSchema(DataAbstractServiceGetTableSchemaEventArgs e)
VB:   Sub TriggerAfterGetTableSchema(e As DataAbstractServiceGetTableSchemaEventArgs)


Parameters:

  • e:


TriggerAfterProcessChange   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterProcessChange(e: DeltaChangeEventArgs)
C#:   void TriggerAfterProcessChange(DeltaChangeEventArgs e)
VB:   Sub TriggerAfterProcessChange(e As DeltaChangeEventArgs)


Parameters:

  • e:


TriggerAfterProcessDelta   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterProcessDelta(e: DeltaEventArgs)
C#:   void TriggerAfterProcessDelta(DeltaEventArgs e)
VB:   Sub TriggerAfterProcessDelta(e As DeltaEventArgs)


Parameters:

  • e:


TriggerAfterReleaseConnection   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterReleaseConnection(e: ConnectionOperationEventArgs)
C#:   void TriggerAfterReleaseConnection(ConnectionOperationEventArgs e)
VB:   Sub TriggerAfterReleaseConnection(e As ConnectionOperationEventArgs)


Parameters:

  • e:


TriggerAfterRollBackTransaction   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterRollBackTransaction(e: TransactionOperationEventArgs)
C#:   void TriggerAfterRollBackTransaction(TransactionOperationEventArgs e)
VB:   Sub TriggerAfterRollBackTransaction(e As TransactionOperationEventArgs)


Parameters:

  • e:


TriggerAfterSqlGeneration   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterSqlGeneration(e: SqlGenerationEventArgs)
C#:   void TriggerAfterSqlGeneration(SqlGenerationEventArgs e)
VB:   Sub TriggerAfterSqlGeneration(e As SqlGenerationEventArgs)


Parameters:

  • e:


TriggerAfterUpdateData   protected     (declared in DataAbstractService)



Oxygene:   method TriggerAfterUpdateData(e: DataAbstractServiceUpdateDataEventArgs)
C#:   void TriggerAfterUpdateData(DataAbstractServiceUpdateDataEventArgs e)
VB:   Sub TriggerAfterUpdateData(e As DataAbstractServiceUpdateDataEventArgs)


Parameters:

  • e:


TriggerBeforeAcquireConnection   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeAcquireConnection(e: BeforeAcquireConnectionEventArgs)
C#:   void TriggerBeforeAcquireConnection(BeforeAcquireConnectionEventArgs e)
VB:   Sub TriggerBeforeAcquireConnection(e As BeforeAcquireConnectionEventArgs)


Parameters:

  • e:


TriggerBeforeActivate   protected     (declared in Service)



Oxygene:   method TriggerBeforeActivate(sessionId: Guid)
C#:   void TriggerBeforeActivate(Guid sessionId)
VB:   Sub TriggerBeforeActivate(sessionId As Guid)


Parameters:

  • sessionId:


TriggerBeforeBeginTransaction   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeBeginTransaction(e: TransactionOperationEventArgs)
C#:   void TriggerBeforeBeginTransaction(TransactionOperationEventArgs e)
VB:   Sub TriggerBeforeBeginTransaction(e As TransactionOperationEventArgs)


Parameters:

  • e:


TriggerBeforeCommitTransaction   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeCommitTransaction(e: TransactionOperationEventArgs)
C#:   void TriggerBeforeCommitTransaction(TransactionOperationEventArgs e)
VB:   Sub TriggerBeforeCommitTransaction(e As TransactionOperationEventArgs)


Parameters:

  • e:


TriggerBeforeDeactivate   protected     (declared in Service)



Oxygene:   method TriggerBeforeDeactivate(sessionId: Guid)
C#:   void TriggerBeforeDeactivate(Guid sessionId)
VB:   Sub TriggerBeforeDeactivate(sessionId As Guid)


Parameters:

  • sessionId:


TriggerBeforeExecuteCommand (DataAbstractServiceExecuteCommandEventArgs)   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeExecuteCommand(e: DataAbstractServiceExecuteCommandEventArgs)
C#:   void TriggerBeforeExecuteCommand(DataAbstractServiceExecuteCommandEventArgs e)
VB:   Sub TriggerBeforeExecuteCommand(e As DataAbstractServiceExecuteCommandEventArgs)


Parameters:

  • e:


TriggerBeforeExecuteCommand (ExecuteCommandArgs)   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeExecuteCommand(e: ExecuteCommandArgs)
C#:   void TriggerBeforeExecuteCommand(ExecuteCommandArgs e)
VB:   Sub TriggerBeforeExecuteCommand(e As ExecuteCommandArgs)


Parameters:

  • e:


TriggerBeforeExecutingGetDataReader   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeExecutingGetDataReader(e: BeforeExecutingGetDataReaderEventArgs)
C#:   void TriggerBeforeExecutingGetDataReader(BeforeExecutingGetDataReaderEventArgs e)
VB:   Sub TriggerBeforeExecutingGetDataReader(e As BeforeExecutingGetDataReaderEventArgs)


Parameters:

  • e:


TriggerBeforeFindServiceSchema   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeFindServiceSchema(e: BeforeFindServiceSchemaEventArgs)
C#:   void TriggerBeforeFindServiceSchema(BeforeFindServiceSchemaEventArgs e)
VB:   Sub TriggerBeforeFindServiceSchema(e As BeforeFindServiceSchemaEventArgs)


Parameters:

  • e:


TriggerBeforeGetCommandSchema   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeGetCommandSchema(e: DataAbstractServiceGetCommandSchemaEventArgs)
C#:   void TriggerBeforeGetCommandSchema(DataAbstractServiceGetCommandSchemaEventArgs e)
VB:   Sub TriggerBeforeGetCommandSchema(e As DataAbstractServiceGetCommandSchemaEventArgs)


Parameters:

  • e:


TriggerBeforeGetData   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeGetData(e: DataAbstractServiceGetDataEventArgs)
C#:   void TriggerBeforeGetData(DataAbstractServiceGetDataEventArgs e)
VB:   Sub TriggerBeforeGetData(e As DataAbstractServiceGetDataEventArgs)


Parameters:

  • e:


TriggerBeforeGetSchema   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeGetSchema(e: DataAbstractServiceGetSchemaEventArgs)
C#:   void TriggerBeforeGetSchema(DataAbstractServiceGetSchemaEventArgs e)
VB:   Sub TriggerBeforeGetSchema(e As DataAbstractServiceGetSchemaEventArgs)


Parameters:

  • e:


TriggerBeforeGetTableData   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeGetTableData(e: BeforeGetTableDataEventArgs)
C#:   void TriggerBeforeGetTableData(BeforeGetTableDataEventArgs e)
VB:   Sub TriggerBeforeGetTableData(e As BeforeGetTableDataEventArgs)


Parameters:

  • e:


TriggerBeforeGetTableSchema   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeGetTableSchema(e: DataAbstractServiceGetTableSchemaEventArgs)
C#:   void TriggerBeforeGetTableSchema(DataAbstractServiceGetTableSchemaEventArgs e)
VB:   Sub TriggerBeforeGetTableSchema(e As DataAbstractServiceGetTableSchemaEventArgs)


Parameters:

  • e:


TriggerBeforeProcessChange   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeProcessChange(e: DeltaChangeEventArgs)
C#:   void TriggerBeforeProcessChange(DeltaChangeEventArgs e)
VB:   Sub TriggerBeforeProcessChange(e As DeltaChangeEventArgs)


Parameters:

  • e:


TriggerBeforeProcessDelta   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeProcessDelta(e: DeltaEventArgs)
C#:   void TriggerBeforeProcessDelta(DeltaEventArgs e)
VB:   Sub TriggerBeforeProcessDelta(e As DeltaEventArgs)


Parameters:

  • e:


TriggerBeforeReleaseConnection   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeReleaseConnection(e: ConnectionOperationEventArgs)
C#:   void TriggerBeforeReleaseConnection(ConnectionOperationEventArgs e)
VB:   Sub TriggerBeforeReleaseConnection(e As ConnectionOperationEventArgs)


Parameters:

  • e:


TriggerBeforeRollBackTransaction   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeRollBackTransaction(e: TransactionOperationEventArgs)
C#:   void TriggerBeforeRollBackTransaction(TransactionOperationEventArgs e)
VB:   Sub TriggerBeforeRollBackTransaction(e As TransactionOperationEventArgs)


Parameters:

  • e:


TriggerBeforeUpdateData   protected     (declared in DataAbstractService)



Oxygene:   method TriggerBeforeUpdateData(e: DataAbstractServiceUpdateDataEventArgs)
C#:   void TriggerBeforeUpdateData(DataAbstractServiceUpdateDataEventArgs e)
VB:   Sub TriggerBeforeUpdateData(e As DataAbstractServiceUpdateDataEventArgs)


Parameters:

  • e:


TriggerProcessError   protected     (declared in DataAbstractService)



Oxygene:   method TriggerProcessError(e: DeltaChangeErrorEventArgs)
C#:   void TriggerProcessError(DeltaChangeErrorEventArgs e)
VB:   Sub TriggerProcessError(e As DeltaChangeErrorEventArgs)


Parameters:

  • e:


TriggerUnknownSqlMacroIdentifier   protected     (declared in DataAbstractService)



Oxygene:   method TriggerUnknownSqlMacroIdentifier(sender: Object; aName: String; aOriginalName: String; var aValue: String): Boolean
C#:   Boolean TriggerUnknownSqlMacroIdentifier(Object sender, String aName, String aOriginalName, ref String aValue)
VB:   Function TriggerUnknownSqlMacroIdentifier(sender As Object, aName As String, aOriginalName As String, ByRef aValue As String) As Boolean


Parameters:

  • sender:
  • aName:
  • aOriginalName:
  • aValue:


TriggerUpdateDataError   protected     (declared in DataAbstractService)



Oxygene:   method TriggerUpdateDataError(e: DataAbstractServiceUpdateDataEventArgs)
C#:   void TriggerUpdateDataError(DataAbstractServiceUpdateDataEventArgs e)
VB:   Sub TriggerUpdateDataError(e As DataAbstractServiceUpdateDataEventArgs)


Parameters:

  • e:


TriggerValidateCommandExecution   protected     (declared in DataAbstractService)



Oxygene:   method TriggerValidateCommandExecution(e: DataAbstractServiceValidateDBObjectAccessEventArgs)
C#:   void TriggerValidateCommandExecution(DataAbstractServiceValidateDBObjectAccessEventArgs e)
VB:   Sub TriggerValidateCommandExecution(e As DataAbstractServiceValidateDBObjectAccessEventArgs)


Parameters:

  • e:


TriggerValidateDataTableAccess   protected     (declared in DataAbstractService)



Oxygene:   method TriggerValidateDataTableAccess(e: DataAbstractServiceValidateDBObjectAccessEventArgs)
C#:   void TriggerValidateDataTableAccess(DataAbstractServiceValidateDBObjectAccessEventArgs e)
VB:   Sub TriggerValidateDataTableAccess(e As DataAbstractServiceValidateDBObjectAccessEventArgs)


Parameters:

  • e:


TriggerValidateDirectSQLAccess   protected     (declared in DataAbstractService)



Oxygene:   method TriggerValidateDirectSQLAccess(e: DataAbstractServiceSQLValidationEventArgs)
C#:   void TriggerValidateDirectSQLAccess(DataAbstractServiceSQLValidationEventArgs e)
VB:   Sub TriggerValidateDirectSQLAccess(e As DataAbstractServiceSQLValidationEventArgs)


Parameters:

  • e:


TriggerValidateRoles   protected     (declared in Service)



Oxygene:   method TriggerValidateRoles(roles: array of String; allowByDefault: Boolean): Boolean
C#:   Boolean TriggerValidateRoles(array of String roles, Boolean allowByDefault)
VB:   Function TriggerValidateRoles(roles As array of String, allowByDefault As Boolean) As Boolean


Parameters:

  • roles:
  • allowByDefault:


UnpackDeltas   protected     (declared in DataAbstractService)



Oxygene:   method UnpackDeltas(deltaData: Binary; streamer: DataStreamer; out deltas: NamedObjectCollection<Delta>): Int32
C#:   Int32 UnpackDeltas(Binary deltaData, DataStreamer streamer, out NamedObjectCollection<Delta> deltas)
VB:   Function UnpackDeltas(deltaData As Binary, streamer As DataStreamer, <OutAttribute> ByRef deltas As NamedObjectCollection<Delta>) As Int32


Parameters:

  • deltaData:
  • streamer:
  • deltas:


UnRegisterAllBusinessProcessors   protected     (declared in DataAbstractService)



Oxygene:   method UnRegisterAllBusinessProcessors
C#:   void UnRegisterAllBusinessProcessors()
VB:   Sub UnRegisterAllBusinessProcessors


UnregisterBusinessProcessor   protected     (declared in DataAbstractService)



Oxygene:   method UnregisterBusinessProcessor(aBusinessProcessor: BusinessProcessor)
C#:   void UnregisterBusinessProcessor(BusinessProcessor aBusinessProcessor)
VB:   Sub UnregisterBusinessProcessor(aBusinessProcessor As BusinessProcessor)


Parameters:

  • aBusinessProcessor:


UnregisterForDataChangeNotification     (declared in DataAbstractService)



Oxygene:   method UnregisterForDataChangeNotification(tableName: String)
C#:   void UnregisterForDataChangeNotification(String tableName)
VB:   Sub UnregisterForDataChangeNotification(tableName As String)


Parameters:

  • tableName:


UnsubscribeClientEventSink ()     (declared in Service)

This method will unsubscribe the current client from all available event sinks that it is subscribed to. The client will no longer receive any events.


Oxygene:   method UnsubscribeClientEventSink
C#:   void UnsubscribeClientEventSink()
VB:   Sub UnsubscribeClientEventSink


UnsubscribeClientEventSink (Type)     (declared in Service)



Oxygene:   method UnsubscribeClientEventSink(eventSink: Type)
C#:   void UnsubscribeClientEventSink(Type eventSink)
VB:   Sub UnsubscribeClientEventSink(eventSink As Type)


Parameters:

  • eventSink:


UpdateData     (declared in DataAbstractService)

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.


Oxygene:   method UpdateData(serializedDelta: Binary): Binary
C#:   Binary UpdateData(Binary serializedDelta)
VB:   Function UpdateData(serializedDelta As Binary) As Binary


Parameters:

  • serializedDelta:


Events

AfterAcquireConnection     (declared in DataAbstractService)

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.



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

C#:   event ConnectionOperationEventHandler AfterAcquireConnection
delegate: void Invoke(DataAbstractService sender, ConnectionOperationEventArgs e)

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


AfterActivate     (declared in Service)

Gets triggered after your object has been activated. You can use this to perform initialization tasks or inspect Session data.



Oxygene:   event AfterActivate: ServiceActivationEventHandler
delegate: method Invoke(sender: Object; e: ServiceActivationEventArgs)

C#:   event ServiceActivationEventHandler AfterActivate
delegate: void Invoke(Object sender, ServiceActivationEventArgs e)

VB:   Event AfterActivate As ServiceActivationEventHandler
delegate: Sub Invoke(sender As Object, e As ServiceActivationEventArgs)


AfterAutoCreateBusinessProcessor     (declared in DataAbstractService)

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.



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

C#:   event BusinessProcessorAutoCreatedEventHandler AfterAutoCreateBusinessProcessor
delegate: void Invoke(DataAbstractService sender, BusinessProcessorAutoCreatedEventArgs e)

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


AfterBeginTransaction     (declared in DataAbstractService)

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.



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

C#:   event TransactionOperationEventHandler AfterBeginTransaction
delegate: void Invoke(DataAbstractService sender, TransactionOperationEventArgs e)

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


AfterCommitTransaction     (declared in DataAbstractService)

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



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

C#:   event TransactionOperationEventHandler AfterCommitTransaction
delegate: void Invoke(DataAbstractService sender, TransactionOperationEventArgs e)

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


AfterDeactivate     (declared in Service)

Gets triggered after your object has been deactivated. Its session data has already been persisted and can no longer be accessed. You can use this as a last stop to perform cleanup functions.



Oxygene:   event AfterDeactivate: ServiceActivationEventHandler
delegate: method Invoke(sender: Object; e: ServiceActivationEventArgs)

C#:   event ServiceActivationEventHandler AfterDeactivate
delegate: void Invoke(Object sender, ServiceActivationEventArgs e)

VB:   Event AfterDeactivate As ServiceActivationEventHandler
delegate: Sub Invoke(sender As Object, e As ServiceActivationEventArgs)


AfterExecuteCommand     (declared in DataAbstractService)

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.



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

C#:   event DataAbstractServiceExecuteCommandEventHandler AfterExecuteCommand
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceExecuteCommandEventArgs e)

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


AfterFindServiceSchema     (declared in DataAbstractService)

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



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

C#:   event ServiceSchemaOperationEventHandler AfterFindServiceSchema
delegate: void Invoke(DataAbstractService sender, ServiceSchemaOperationEventArgs e)

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


AfterGetCommandSchema     (declared in DataAbstractService)

When a remote client requests the schema for a specific command using the remote GetCommandSchema 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.



Oxygene:   event AfterGetCommandSchema: DataAbstractServiceGetCommandSchemaEventHandler
delegate: method Invoke(sender: DataAbstractService; e: DataAbstractServiceGetCommandSchemaEventArgs)

C#:   event DataAbstractServiceGetCommandSchemaEventHandler AfterGetCommandSchema
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceGetCommandSchemaEventArgs e)

VB:   Event AfterGetCommandSchema As DataAbstractServiceGetCommandSchemaEventHandler
delegate: Sub Invoke(sender As DataAbstractService, e As DataAbstractServiceGetCommandSchemaEventArgs)


AfterGetData     (declared in DataAbstractService)

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.



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

C#:   event DataAbstractServiceGetDataEventHandler AfterGetData
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceGetDataEventArgs e)

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


AfterGetSchema     (declared in DataAbstractService)

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.



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

C#:   event DataAbstractServiceAfterGetSchemaEventHandler AfterGetSchema
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceAfterGetSchemaEventArgs e)

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


AfterGetTableSchema     (declared in DataAbstractService)

When a remote client requests the schema for a specific data table using the remote GetTableSchema 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.



Oxygene:   event AfterGetTableSchema: DataAbstractServiceGetTableSchemaEventHandler
delegate: method Invoke(sender: DataAbstractService; e: DataAbstractServiceGetTableSchemaEventArgs)

C#:   event DataAbstractServiceGetTableSchemaEventHandler AfterGetTableSchema
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceGetTableSchemaEventArgs e)

VB:   Event AfterGetTableSchema As DataAbstractServiceGetTableSchemaEventHandler
delegate: Sub Invoke(sender As DataAbstractService, e As DataAbstractServiceGetTableSchemaEventArgs)


AfterProcessChange     (declared in DataAbstractService)



Oxygene:   event AfterProcessChange: DeltaChangeEventHandler
delegate: method Invoke(sender: BusinessProcessor; e: DeltaChangeEventArgs)

C#:   event DeltaChangeEventHandler AfterProcessChange
delegate: void Invoke(BusinessProcessor sender, DeltaChangeEventArgs e)

VB:   Event AfterProcessChange As DeltaChangeEventHandler
delegate: Sub Invoke(sender As BusinessProcessor, e As DeltaChangeEventArgs)


AfterProcessDelta     (declared in DataAbstractService)



Oxygene:   event AfterProcessDelta: DeltaEventHandler
delegate: method Invoke(sender: BusinessProcessor; e: DeltaEventArgs)

C#:   event DeltaEventHandler AfterProcessDelta
delegate: void Invoke(BusinessProcessor sender, DeltaEventArgs e)

VB:   Event AfterProcessDelta As DeltaEventHandler
delegate: Sub Invoke(sender As BusinessProcessor, e As DeltaEventArgs)


AfterReleaseConnection     (declared in DataAbstractService)

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



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

C#:   event ConnectionOperationEventHandler AfterReleaseConnection
delegate: void Invoke(DataAbstractService sender, ConnectionOperationEventArgs e)

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


AfterRollBackTransaction     (declared in DataAbstractService)

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



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

C#:   event TransactionOperationEventHandler AfterRollBackTransaction
delegate: void Invoke(DataAbstractService sender, TransactionOperationEventArgs e)

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


AfterSqlGeneration     (declared in DataAbstractService)



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

C#:   event SqlGenerationEventHandler AfterSqlGeneration
delegate: void Invoke(BusinessProcessor sender, SqlGenerationEventArgs e)

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


AfterUpdateData     (declared in DataAbstractService)

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.



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

C#:   event DataAbstractServiceUpdateDataEventHandler AfterUpdateData
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceUpdateDataEventArgs e)

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


BeforeAcquireConnection     (declared in DataAbstractService)

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.



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

C#:   event BeforeAcquireConnectionEventHandler BeforeAcquireConnection
delegate: void Invoke(DataAbstractService sender, BeforeAcquireConnectionEventArgs e)

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


BeforeActivate     (declared in Service)

Gets triggered just before your object will be activated. The object is not active yet, and its session data cannot be accessed yet. You can use this to perform initialization functions.



Oxygene:   event BeforeActivate: ServiceActivationEventHandler
delegate: method Invoke(sender: Object; e: ServiceActivationEventArgs)

C#:   event ServiceActivationEventHandler BeforeActivate
delegate: void Invoke(Object sender, ServiceActivationEventArgs e)

VB:   Event BeforeActivate As ServiceActivationEventHandler
delegate: Sub Invoke(sender As Object, e As ServiceActivationEventArgs)


BeforeBeginTransaction     (declared in DataAbstractService)

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.



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

C#:   event TransactionOperationEventHandler BeforeBeginTransaction
delegate: void Invoke(DataAbstractService sender, TransactionOperationEventArgs e)

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


BeforeCommitTransaction     (declared in DataAbstractService)

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.



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

C#:   event TransactionOperationEventHandler BeforeCommitTransaction
delegate: void Invoke(DataAbstractService sender, TransactionOperationEventArgs e)

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


BeforeDeactivate     (declared in Service)

Gets triggered just before your object will be deactivated and its session data will be persisted. You can use this as a last stop to perform cleanup or make adjustments to the session data.



Oxygene:   event BeforeDeactivate: ServiceActivationEventHandler
delegate: method Invoke(sender: Object; e: ServiceActivationEventArgs)

C#:   event ServiceActivationEventHandler BeforeDeactivate
delegate: void Invoke(Object sender, ServiceActivationEventArgs e)

VB:   Event BeforeDeactivate As ServiceActivationEventHandler
delegate: Sub Invoke(sender As Object, e As ServiceActivationEventArgs)


BeforeExecuteCommand     (declared in DataAbstractService)

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.



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

C#:   event DataAbstractServiceExecuteCommandEventHandler BeforeExecuteCommand
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceExecuteCommandEventArgs e)

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


BeforeExecutingGetDataReader     (declared in DataAbstractService)



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

C#:   event BeforeExecutingGetDataReaderEventHandler BeforeExecutingGetDataReader
delegate: void Invoke(ServiceSchema sender, BeforeExecutingGetDataReaderEventArgs e)

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


BeforeFindServiceSchema     (declared in DataAbstractService)

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.



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

C#:   event BeforeFindServiceSchemaEventHandler BeforeFindServiceSchema
delegate: void Invoke(DataAbstractService sender, BeforeFindServiceSchemaEventArgs e)

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


BeforeGetCommandSchema     (declared in DataAbstractService)

When a remote client has requested the schema for a specific command using the remote GetCommandSchema 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.



Oxygene:   event BeforeGetCommandSchema: DataAbstractServiceGetCommandSchemaEventHandler
delegate: method Invoke(sender: DataAbstractService; e: DataAbstractServiceGetCommandSchemaEventArgs)

C#:   event DataAbstractServiceGetCommandSchemaEventHandler BeforeGetCommandSchema
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceGetCommandSchemaEventArgs e)

VB:   Event BeforeGetCommandSchema As DataAbstractServiceGetCommandSchemaEventHandler
delegate: Sub Invoke(sender As DataAbstractService, e As DataAbstractServiceGetCommandSchemaEventArgs)


BeforeGetData     (declared in DataAbstractService)

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.



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

C#:   event DataAbstractServiceGetDataEventHandler BeforeGetData
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceGetDataEventArgs e)

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


BeforeGetSchema     (declared in DataAbstractService)

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.



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

C#:   event DataAbstractServiceGetSchemaEventHandler BeforeGetSchema
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceGetSchemaEventArgs e)

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


BeforeGetTableData     (declared in DataAbstractService)



Oxygene:   event BeforeGetTableData: BeforeGetTableDataEventHandler
delegate: method Invoke(e: BeforeGetTableDataEventArgs)

C#:   event BeforeGetTableDataEventHandler BeforeGetTableData
delegate: void Invoke(BeforeGetTableDataEventArgs e)

VB:   Event BeforeGetTableData As BeforeGetTableDataEventHandler
delegate: Sub Invoke(e As BeforeGetTableDataEventArgs)


BeforeGetTableSchema     (declared in DataAbstractService)

When a remote client requests the schema for a specific data table using the remote GetTableSchema 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.



Oxygene:   event BeforeGetTableSchema: DataAbstractServiceGetTableSchemaEventHandler
delegate: method Invoke(sender: DataAbstractService; e: DataAbstractServiceGetTableSchemaEventArgs)

C#:   event DataAbstractServiceGetTableSchemaEventHandler BeforeGetTableSchema
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceGetTableSchemaEventArgs e)

VB:   Event BeforeGetTableSchema As DataAbstractServiceGetTableSchemaEventHandler
delegate: Sub Invoke(sender As DataAbstractService, e As DataAbstractServiceGetTableSchemaEventArgs)


BeforeProcessChange     (declared in DataAbstractService)



Oxygene:   event BeforeProcessChange: DeltaChangeEventHandler
delegate: method Invoke(sender: BusinessProcessor; e: DeltaChangeEventArgs)

C#:   event DeltaChangeEventHandler BeforeProcessChange
delegate: void Invoke(BusinessProcessor sender, DeltaChangeEventArgs e)

VB:   Event BeforeProcessChange As DeltaChangeEventHandler
delegate: Sub Invoke(sender As BusinessProcessor, e As DeltaChangeEventArgs)


BeforeProcessDelta     (declared in DataAbstractService)



Oxygene:   event BeforeProcessDelta: DeltaEventHandler
delegate: method Invoke(sender: BusinessProcessor; e: DeltaEventArgs)

C#:   event DeltaEventHandler BeforeProcessDelta
delegate: void Invoke(BusinessProcessor sender, DeltaEventArgs e)

VB:   Event BeforeProcessDelta As DeltaEventHandler
delegate: Sub Invoke(sender As BusinessProcessor, e As DeltaEventArgs)


BeforeReleaseConnection     (declared in DataAbstractService)

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.



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

C#:   event ConnectionOperationEventHandler BeforeReleaseConnection
delegate: void Invoke(DataAbstractService sender, ConnectionOperationEventArgs e)

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


BeforeRollBackTransaction     (declared in DataAbstractService)

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.



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

C#:   event TransactionOperationEventHandler BeforeRollBackTransaction
delegate: void Invoke(DataAbstractService sender, TransactionOperationEventArgs e)

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


BeforeUpdateData     (declared in DataAbstractService)

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.



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

C#:   event DataAbstractServiceUpdateDataEventHandler BeforeUpdateData
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceUpdateDataEventArgs e)

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


ExecuteLogin     (declared in MultiDbLoginService)

Occurs when the Login method is called by the remote client. Implement a handler for this event in your descendent login service to handle the user authentication process and create a new session.

When creating a new project based on the Login templates provided by Data Abstract, a default handler will already be provided for you in the LoginService_Impl module. You can then expand this handler to add specific logic and username/password validation.



Oxygene:   event ExecuteLogin: MultiDbLoginEventHandler
delegate: method Invoke(sender: BaseLoginService; e: MultiDbLoginEventArgs)

C#:   event MultiDbLoginEventHandler ExecuteLogin
delegate: void Invoke(BaseLoginService sender, MultiDbLoginEventArgs e)

VB:   Event ExecuteLogin As MultiDbLoginEventHandler
delegate: Sub Invoke(sender As BaseLoginService, e As MultiDbLoginEventArgs)


ExecuteLogout     (declared in BaseLoginService)

Fires when the Logout method is called by the remote client. Implement a handler for this event in your descendent login service to handle the logout process and destroy any existing session. When creating a new project based on the Login templates provided by Data Abstract, a default handler will already be provided for you in the LoginService_Impl module.



Oxygene:   event ExecuteLogout: LogoutEventHandler
delegate: method Invoke(sender: BaseLoginService; e: LogoutEventArgs)

C#:   event LogoutEventHandler ExecuteLogout
delegate: void Invoke(BaseLoginService sender, LogoutEventArgs e)

VB:   Event ExecuteLogout As LogoutEventHandler
delegate: Sub Invoke(sender As BaseLoginService, e As LogoutEventArgs)


ProcessError     (declared in DataAbstractService)



Oxygene:   event ProcessError: DeltaChangeErrorEventHandler
delegate: method Invoke(sender: BusinessProcessor; e: DeltaChangeErrorEventArgs)

C#:   event DeltaChangeErrorEventHandler ProcessError
delegate: void Invoke(BusinessProcessor sender, DeltaChangeErrorEventArgs e)

VB:   Event ProcessError As DeltaChangeErrorEventHandler
delegate: Sub Invoke(sender As BusinessProcessor, e As DeltaChangeErrorEventArgs)


UnknownSqlMacroIdentifier     (declared in DataAbstractService)



Oxygene:   event UnknownSqlMacroIdentifier: UnknownSqlMacroIdentifierEventHandler
delegate: method Invoke(sender: Object; e: UnknownSqlMacroIdentifierEventArgs)

C#:   event UnknownSqlMacroIdentifierEventHandler UnknownSqlMacroIdentifier
delegate: void Invoke(Object sender, UnknownSqlMacroIdentifierEventArgs e)

VB:   Event UnknownSqlMacroIdentifier As UnknownSqlMacroIdentifierEventHandler
delegate: Sub Invoke(sender As Object, e As UnknownSqlMacroIdentifierEventArgs)


UpdateDataError     (declared in DataAbstractService)

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.



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

C#:   event DataAbstractServiceUpdateDataEventHandler UpdateDataError
delegate: void Invoke(DataAbstractService sender, DataAbstractServiceUpdateDataEventArgs e)

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


ValidateCommandExecution     (declared in DataAbstractService)



Oxygene:   event ValidateCommandExecution: DataAbstractServiceValidateDBObjectAccessEventHandler
delegate: method Invoke(e: DataAbstractServiceValidateDBObjectAccessEventArgs)

C#:   event DataAbstractServiceValidateDBObjectAccessEventHandler ValidateCommandExecution
delegate: void Invoke(DataAbstractServiceValidateDBObjectAccessEventArgs e)

VB:   Event ValidateCommandExecution As DataAbstractServiceValidateDBObjectAccessEventHandler
delegate: Sub Invoke(e As DataAbstractServiceValidateDBObjectAccessEventArgs)


ValidateDatatableAccess     (declared in DataAbstractService)



Oxygene:   event ValidateDatatableAccess: DataAbstractServiceValidateDBObjectAccessEventHandler
delegate: method Invoke(e: DataAbstractServiceValidateDBObjectAccessEventArgs)

C#:   event DataAbstractServiceValidateDBObjectAccessEventHandler ValidateDatatableAccess
delegate: void Invoke(DataAbstractServiceValidateDBObjectAccessEventArgs e)

VB:   Event ValidateDatatableAccess As DataAbstractServiceValidateDBObjectAccessEventHandler
delegate: Sub Invoke(e As DataAbstractServiceValidateDBObjectAccessEventArgs)


ValidateDirectSQLAccess     (declared in DataAbstractService)



Oxygene:   event ValidateDirectSQLAccess: DataAbstractServiceSQLValidationEventHandler
delegate: method Invoke(e: DataAbstractServiceSQLValidationEventArgs)

C#:   event DataAbstractServiceSQLValidationEventHandler ValidateDirectSQLAccess
delegate: void Invoke(DataAbstractServiceSQLValidationEventArgs e)

VB:   Event ValidateDirectSQLAccess As DataAbstractServiceSQLValidationEventHandler
delegate: Sub Invoke(e As DataAbstractServiceSQLValidationEventArgs)


ValidateRoles     (declared in Service)

This is triggered for methods that have roles set and can be used to override if a client is allowed or not.



Oxygene:   event ValidateRoles: ValidateRolesEventHandler
delegate: method Invoke(sender: Object; e: ValidateRolesEventArgs)

C#:   event ValidateRolesEventHandler ValidateRoles
delegate: void Invoke(Object sender, ValidateRolesEventArgs e)

VB:   Event ValidateRoles As ValidateRolesEventHandler
delegate: Sub Invoke(sender As Object, e As ValidateRolesEventArgs)


See Also


Product: RemObjects Data Abstract
Available Editions: Data Abstract for .NET, Delphi and Xcode

Glossary — Articles — Features — Library — Samples

Retrieved from "http://wiki.remobjects.com/w/index.php?title=MultiDbLoginServiceV5_Class&oldid=82865"
Personal tools
Namespaces

Variants
Actions
Navigation
products
platforms
special
Toolbox