TDABaseEcmaScriptProvider

 

Standard component constructor

constructor Create(AOwner: TComponent)

Parameters:

• AOwner: Owner

---

Called just after a transaction (set of insert/update/delete) has been committed.

procedure AfterCommit

---

Called after an sql command is executed.

procedure AfterExecuteCommand(aSQL: string; aCommandName: string; aParameters: DataParameterArray; aRowsAffected: Integer)

Parameters:

• aSQL: sql
• aCommandName: command name
• aParameters: parameters
• aRowsAffected: rows affected

---

Called after a request for data is sent.

procedure AfterGetData(aTables: StringArray; aRequestInfo: TableRequestInfoArray)

Parameters:

• aTables: table's names
• aRequestInfo: request infos

---

Called for each Delta on the server after it's applied. Any changes done to the delta will only be sent back to the client.

procedure AfterProcessDelta(aDelta: IDADelta)

Parameters:

• aDelta: delta

---

Called after each change is applied to the database.

procedure AfterProcessDeltaChange(aDelta: IDADelta; aChange: TDADeltaChange; aWasRefreshed: Boolean)

Parameters:

• aDelta: delta
• aChange: change
• aWasRefreshed: mode

---

Called just after a transaction (set of insert/update/delete) is rolled back (canceled).

procedure AfterRollback

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Called just before a transaction (set of insert/update/delete) has been committed.

procedure BeforeCommit

---

Called when the client (or server depending on the schema settings) deletes a record.

procedure BeforeDelete(aRow: IDARowHelper)

Parameters:

• aRow: record

---

Called before an SQL command is executed.

procedure BeforeExecuteCommand(aSQL: string; aCommandName: string; aParameters: DataParameterArray)

Parameters:

• aSQL: sql command
• aCommandName: command's name
• aParameters: parameters

---

Called before a request for data is sent.

procedure BeforeGetData(aTables: StringArray; aRequestInfo: TableRequestInfoArray)

Parameters:

• aTables: table's names
• aRequestInfo: request infos

---

Called before a change to a record is accepted.

procedure BeforePost(aRow: IDARowHelper)

Parameters:

• aRow: record

---

Called for each delta on the server before it's applied. Any changes done to the delta will be posted to the database.

procedure BeforeProcessDelta(aDelta: IDADelta)

Parameters:

• aDelta: delta

---

Called before each change is applied to the database. Any implementation should return the current value of canRemove unless it changed.

procedure BeforeProcessDeltaChange(aDelta: IDADelta; aChange: TDADeltaChange; aWasRefreshed: Boolean; var aCanRemove: Boolean)

Parameters:

• aDelta: delta
• aChange: change
• aWasRefreshed: mode
• aCanRemove: specifies that this change can be removed from sending back to client

---

Called just before a transaction (set of insert/update/delete) is rolled back (canceled).

procedure BeforeRollback

---

Represents specified contextual information about current instance.

property Context: IDAScriptContext read write

---

Called when a new transaction is created to fetch or update records.

procedure CreateTransaction

---

Fires OnContextChanged event.

procedure DoContextChangedArgs(aEngine: TDAEcmaScriptEngine; aContext: IDAScriptContext; aServerContext: IDAServerScriptContext; IsSubscript: Boolean; aSubScript: string)

Parameters:

• aEngine:
• aContext:
• aServerContext:
• IsSubscript:
• aSubScript:

---

Fires OnError event

procedure DoError(aError: ScriptException)

Parameters:

• aError: Exception

---

Fires OnLog event

procedure DoLog(aMessage: string)

Parameters:

• aMessage: Message

---

Represents native engine components that gives additional functionality.

For example, Engine object can be used to set custom functions as follows:

ScriptProvider.Engine.Variables.SetVariable('Base64GUID', Base64GUID);

property Engine: TDAEcmaScriptEngine read

---

Raises the specified exception.

function Fail(args: array of Variant): Variant

Parameters:

• args: Specified array of parameters.

---

Returns default engine class for current script provider.

function GetEngineClass: TDAEcmaScriptEngineClass

---

Specifies LDAWrapper class.

function GetLDAWrapperClass: TDAEcmaLDAWrapperClass

---

Implements IDANativeAccess method. Returns Self

function GetNative: TObject

---

Specifies WhereBuilderMethods class.

function GetWhereBuilderClass: TDAEcmaWhereBuilderMethodsClass

---

Returns true if AfterCommit script is present. In other cases returns false.

property HasAfterCommit: Boolean read

---

Returns true if AfterExecuteCommand script is present. In other cases returns false.

property HasAfterExecuteCommand: Boolean read

---

Returns true if AfterGetData script is present. In other cases returns false.

property HasAfterGetData: Boolean read

---

Returns true if AfterProcessDelta script is present. In other cases returns false.

property HasAfterProcessDelta: Boolean read

---

Returns true if AfterProcessDeltaChange script is present. In other cases returns false.

property HasAfterProcessDeltaChange: Boolean read

---

Returns true if AfterRollback script is present. In other cases returns false.

property HasAfterRollback: Boolean read

---

Returns true if BeforeCommit script is present. In other cases returns false.

property HasBeforeCommit: Boolean read

---

Returns true if BeforeDelete script is present. In other cases returns false.

property HasBeforeDelete[aTable: string]: Boolean read

---

Returns true if BeforeExecuteCommand script is present. In other cases returns false.

property HasBeforeExecuteCommand: Boolean read

---

Returns true if BeforeGetData script is present. In other cases returns false.

property HasBeforeGetData: Boolean read

---

Returns true if BeforePost script is present. In other cases returns false.

property HasBeforePost[aTable: string]: Boolean read

---

Returns true if BeforeProcessDelta script is present. In other cases returns false.

property HasBeforeProcessDelta: Boolean read

---

Returns true if BeforeProcessDeltaChange script is present. In other cases returns false.

property HasBeforeProcessDeltaChange: Boolean read

---

Returns true if BeforeRollback script is present. In other cases returns false.

property HasBeforeRollback: Boolean read

---

Returns true if CreateTransaction script is present. In other cases returns false.

property HasCreateTransaction: Boolean read

---

Returns true if OnNewRow script is present. In other cases returns false.

property HasOnNewRow[aTable: string]: Boolean read

---

Returns true if ProcessError script is present. In other cases returns false.

property HasProcessError: Boolean read

---

Returns true if onUnknownSqlMacroIdentifier script is present. In other cases returns false.

property HasUnknownSqlMacroIdentifier: Boolean read

---

Returns true if ValidateCommandAccess script is present. In other cases returns false.

property HasValidateCommandAccess: Boolean read

---

Returns true.

property HasValidateDataTableAccess: Boolean read

---

Returns true.

property HasValidateDirectSQLAccess: Boolean read

---

Used for additional initialization of engine.

procedure InitializeEngine(aEngine: TDAEcmaScriptEngine)

Parameters:

• aEngine: Engine

---

Loads specified script.

procedure LoadScript(aScript: string)

Parameters:

• aScript: Specified script.

---

Logs specified information.

function LogMessage(args: array of Variant): Variant

Parameters:

• args: Specified collection with information need to log.

---

Creates and returns new Guid value.

function NewGuid(args: array of Variant): Variant

Parameters:

• args: are not used.

---

Creates and returns new Guid value as string.

function NewGuidString(args: array of Variant): Variant

Parameters:

• args: are not used.

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

Fires when Context property is changing.

property OnContextChanged: TDABaseEcmaScriptContextChangedArgs read write
delegate:  procedure OnContextChanged(aEcmaScriptProvider: TDABaseEcmaScriptProvider; aEngine: TDAEcmaScriptEngine; aContext: IDAScriptContext; aServerContext: IDAServerScriptContext; IsSubscript: Boolean; aSubScript: string)

---

Fires when Error is happed.

property OnError: TDABaseEcmaScriptErrorEvent read write
delegate:  procedure OnError(aEcmaScriptProvider: TDABaseEcmaScriptProvider; aError: ScriptException)

---

Fires when script execute function LogMessage to log specified information.

property OnLog: TDABaseEcmaScriptLogEvent read write
delegate:  procedure OnLog(aEcmaScriptProvider: TDABaseEcmaScriptProvider; aMessage: string)

---

Called when creating new rows, it can be used to initialize new records.

procedure OnNewRow(aRow: IDARowHelper)

Parameters:

• aRow: Row

---

Called when an error occurs during applying a change. Should return the current value of aCanContinue, or false to stop trying the next change.

procedure ProcessError(aDelta: IDADelta; aChange: TDADeltaChange; var aCanContinue: Boolean; var aError: Exception)

Parameters:

• aDelta: Delta instance containing failed data change
• aChange: DeltaChange that cannot be applied to the database
• aCanContinue: Flag indicating wthether Data Abstract should process other DeltaChange instances instead of rolling back the transaction immediately
• aError: Exception raised by the data change attempt

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

property ScriptableComponent: TScriptableComponent read write

---

Used for convertation of Script object into variant object.

TDAActiveScriptProvider converts ScriptObject into COM compatible object.

function ScriptObjectToVariant(aObj: TDAEcmaBaseScriptObject): Variant

Parameters:

• aObj: Object

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Represent the whole list of Scripts for every data table in the TDASchema.

property SubScripts: TObjectDictionary<string, TDAEcmaScriptEngine> read

---

Returns true if aName equals: js, javascript, jscript, ecmascript, rsljavascript. Otherwise returns false.

function SupportsLanguage(aName: string): Boolean

Parameters:

• aName: specified language name.

---

Called when an unknown macro is used from within an sql statement.

procedure UnknownSqlMacroIdentifier(aIdentifier: string; var aValue: string)

Parameters:

• aIdentifier: identifier.
• aValue: value.

---

Called before a command is executed. Should return true if access is allowed.

procedure ValidateCommandAccess(aName: string; aParameterNames: array of string; aParameterValues: array of Variant; var aAllowed: Boolean)

Parameters:

• aName: command name.
• aParameterNames: parameter names
• aParameterValues: parameter values
• aAllowed: contains access state

---

Called during validation of request (fetching) for a data table. Should return true if access to that table should be allowed.

procedure ValidateDataTableAccess(aName: string; aParameterNames: array of string; aParameterValues: array of Variant; var aAllowed: Boolean)

Parameters:

• aName: table name
• aParameterNames: parameter names
• aParameterValues: parameter values
• aAllowed: contains access state

---

Called when a user executes raw sql, generally this is disabled but can be allowed by returning true here.

procedure ValidateDirectSQLAccess(aSQL: string; aParameterNames: array of string; aParameterValues: array of Variant; var aAllowed: Boolean)

Parameters:

• aSQL: raw sql.
• aParameterNames: parameter names
• aParameterValues: parameter values
• aAllowed: contains access state

---

Converts array of variant into variant.

function VariantArrayToEcmaVariant(args: array of Variant): Variant

Parameters:

• args: array of variant

 

Represents specified contextual information about current instance.

property Context: IDAScriptContext read write

---

Represents native engine components that gives additional functionality.

For example, Engine object can be used to set custom functions as follows:

ScriptProvider.Engine.Variables.SetVariable('Base64GUID', Base64GUID);

property Engine: TDAEcmaScriptEngine read

---

Returns true if AfterCommit script is present. In other cases returns false.

property HasAfterCommit: Boolean read

---

Returns true if AfterExecuteCommand script is present. In other cases returns false.

property HasAfterExecuteCommand: Boolean read

---

Returns true if AfterGetData script is present. In other cases returns false.

property HasAfterGetData: Boolean read

---

Returns true if AfterProcessDelta script is present. In other cases returns false.

property HasAfterProcessDelta: Boolean read

---

Returns true if AfterProcessDeltaChange script is present. In other cases returns false.

property HasAfterProcessDeltaChange: Boolean read

---

Returns true if AfterRollback script is present. In other cases returns false.

property HasAfterRollback: Boolean read

---

Returns true if BeforeCommit script is present. In other cases returns false.

property HasBeforeCommit: Boolean read

---

Returns true if BeforeDelete script is present. In other cases returns false.

property HasBeforeDelete[aTable: string]: Boolean read

---

Returns true if BeforeExecuteCommand script is present. In other cases returns false.

property HasBeforeExecuteCommand: Boolean read

---

Returns true if BeforeGetData script is present. In other cases returns false.

property HasBeforeGetData: Boolean read

---

Returns true if BeforePost script is present. In other cases returns false.

property HasBeforePost[aTable: string]: Boolean read

---

Returns true if BeforeProcessDelta script is present. In other cases returns false.

property HasBeforeProcessDelta: Boolean read

---

Returns true if BeforeProcessDeltaChange script is present. In other cases returns false.

property HasBeforeProcessDeltaChange: Boolean read

---

Returns true if BeforeRollback script is present. In other cases returns false.

property HasBeforeRollback: Boolean read

---

Returns true if CreateTransaction script is present. In other cases returns false.

property HasCreateTransaction: Boolean read

---

Returns true if OnNewRow script is present. In other cases returns false.

property HasOnNewRow[aTable: string]: Boolean read

---

Returns true if ProcessError script is present. In other cases returns false.

property HasProcessError: Boolean read

---

Returns true if onUnknownSqlMacroIdentifier script is present. In other cases returns false.

property HasUnknownSqlMacroIdentifier: Boolean read

---

Returns true if ValidateCommandAccess script is present. In other cases returns false.

property HasValidateCommandAccess: Boolean read

---

Returns true.

property HasValidateDataTableAccess: Boolean read

---

Returns true.

property HasValidateDirectSQLAccess: Boolean read

---

property ScriptableComponent: TScriptableComponent read write

---

Represent the whole list of Scripts for every data table in the TDASchema.

property SubScripts: TObjectDictionary<string, TDAEcmaScriptEngine> read

 

Standard component constructor

constructor Create(AOwner: TComponent)

Parameters:

• AOwner: Owner

---

Called just after a transaction (set of insert/update/delete) has been committed.

procedure AfterCommit

---

Called after an sql command is executed.

procedure AfterExecuteCommand(aSQL: string; aCommandName: string; aParameters: DataParameterArray; aRowsAffected: Integer)

Parameters:

• aSQL: sql
• aCommandName: command name
• aParameters: parameters
• aRowsAffected: rows affected

---

Called after a request for data is sent.

procedure AfterGetData(aTables: StringArray; aRequestInfo: TableRequestInfoArray)

Parameters:

• aTables: table's names
• aRequestInfo: request infos

---

Called for each Delta on the server after it's applied. Any changes done to the delta will only be sent back to the client.

procedure AfterProcessDelta(aDelta: IDADelta)

Parameters:

• aDelta: delta

---

Called after each change is applied to the database.

procedure AfterProcessDeltaChange(aDelta: IDADelta; aChange: TDADeltaChange; aWasRefreshed: Boolean)

Parameters:

• aDelta: delta
• aChange: change
• aWasRefreshed: mode

---

Called just after a transaction (set of insert/update/delete) is rolled back (canceled).

procedure AfterRollback

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Called just before a transaction (set of insert/update/delete) has been committed.

procedure BeforeCommit

---

Called when the client (or server depending on the schema settings) deletes a record.

procedure BeforeDelete(aRow: IDARowHelper)

Parameters:

• aRow: record

---

Called before an SQL command is executed.

procedure BeforeExecuteCommand(aSQL: string; aCommandName: string; aParameters: DataParameterArray)

Parameters:

• aSQL: sql command
• aCommandName: command's name
• aParameters: parameters

---

Called before a request for data is sent.

procedure BeforeGetData(aTables: StringArray; aRequestInfo: TableRequestInfoArray)

Parameters:

• aTables: table's names
• aRequestInfo: request infos

---

Called before a change to a record is accepted.

procedure BeforePost(aRow: IDARowHelper)

Parameters:

• aRow: record

---

Called for each delta on the server before it's applied. Any changes done to the delta will be posted to the database.

procedure BeforeProcessDelta(aDelta: IDADelta)

Parameters:

• aDelta: delta

---

Called before each change is applied to the database. Any implementation should return the current value of canRemove unless it changed.

procedure BeforeProcessDeltaChange(aDelta: IDADelta; aChange: TDADeltaChange; aWasRefreshed: Boolean; var aCanRemove: Boolean)

Parameters:

• aDelta: delta
• aChange: change
• aWasRefreshed: mode
• aCanRemove: specifies that this change can be removed from sending back to client

---

Called just before a transaction (set of insert/update/delete) is rolled back (canceled).

procedure BeforeRollback

---

Called when a new transaction is created to fetch or update records.

procedure CreateTransaction

---

Fires OnContextChanged event.

procedure DoContextChangedArgs(aEngine: TDAEcmaScriptEngine; aContext: IDAScriptContext; aServerContext: IDAServerScriptContext; IsSubscript: Boolean; aSubScript: string)

Parameters:

• aEngine:
• aContext:
• aServerContext:
• IsSubscript:
• aSubScript:

---

Fires OnError event

procedure DoError(aError: ScriptException)

Parameters:

• aError: Exception

---

Fires OnLog event

procedure DoLog(aMessage: string)

Parameters:

• aMessage: Message

---

Raises the specified exception.

function Fail(args: array of Variant): Variant

Parameters:

• args: Specified array of parameters.

---

Returns default engine class for current script provider.

function GetEngineClass: TDAEcmaScriptEngineClass

---

Specifies LDAWrapper class.

function GetLDAWrapperClass: TDAEcmaLDAWrapperClass

---

Implements IDANativeAccess method. Returns Self

function GetNative: TObject

---

Specifies WhereBuilderMethods class.

function GetWhereBuilderClass: TDAEcmaWhereBuilderMethodsClass

---

Used for additional initialization of engine.

procedure InitializeEngine(aEngine: TDAEcmaScriptEngine)

Parameters:

• aEngine: Engine

---

Loads specified script.

procedure LoadScript(aScript: string)

Parameters:

• aScript: Specified script.

---

Logs specified information.

function LogMessage(args: array of Variant): Variant

Parameters:

• args: Specified collection with information need to log.

---

Creates and returns new Guid value.

function NewGuid(args: array of Variant): Variant

Parameters:

• args: are not used.

---

Creates and returns new Guid value as string.

function NewGuidString(args: array of Variant): Variant

Parameters:

• args: are not used.

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

Called when creating new rows, it can be used to initialize new records.

procedure OnNewRow(aRow: IDARowHelper)

Parameters:

• aRow: Row

---

Called when an error occurs during applying a change. Should return the current value of aCanContinue, or false to stop trying the next change.

procedure ProcessError(aDelta: IDADelta; aChange: TDADeltaChange; var aCanContinue: Boolean; var aError: Exception)

Parameters:

• aDelta: Delta instance containing failed data change
• aChange: DeltaChange that cannot be applied to the database
• aCanContinue: Flag indicating wthether Data Abstract should process other DeltaChange instances instead of rolling back the transaction immediately
• aError: Exception raised by the data change attempt

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Used for convertation of Script object into variant object.

TDAActiveScriptProvider converts ScriptObject into COM compatible object.

function ScriptObjectToVariant(aObj: TDAEcmaBaseScriptObject): Variant

Parameters:

• aObj: Object

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Returns true if aName equals: js, javascript, jscript, ecmascript, rsljavascript. Otherwise returns false.

function SupportsLanguage(aName: string): Boolean

Parameters:

• aName: specified language name.

---

Called when an unknown macro is used from within an sql statement.

procedure UnknownSqlMacroIdentifier(aIdentifier: string; var aValue: string)

Parameters:

• aIdentifier: identifier.
• aValue: value.

---

Called before a command is executed. Should return true if access is allowed.

procedure ValidateCommandAccess(aName: string; aParameterNames: array of string; aParameterValues: array of Variant; var aAllowed: Boolean)

Parameters:

• aName: command name.
• aParameterNames: parameter names
• aParameterValues: parameter values
• aAllowed: contains access state

---

Called during validation of request (fetching) for a data table. Should return true if access to that table should be allowed.

procedure ValidateDataTableAccess(aName: string; aParameterNames: array of string; aParameterValues: array of Variant; var aAllowed: Boolean)

Parameters:

• aName: table name
• aParameterNames: parameter names
• aParameterValues: parameter values
• aAllowed: contains access state

---

Called when a user executes raw sql, generally this is disabled but can be allowed by returning true here.

procedure ValidateDirectSQLAccess(aSQL: string; aParameterNames: array of string; aParameterValues: array of Variant; var aAllowed: Boolean)

Parameters:

• aSQL: raw sql.
• aParameterNames: parameter names
• aParameterValues: parameter values
• aAllowed: contains access state

---

Converts array of variant into variant.

function VariantArrayToEcmaVariant(args: array of Variant): Variant

Parameters:

• args: array of variant

 

Fires when Context property is changing.

property OnContextChanged: TDABaseEcmaScriptContextChangedArgs read write
delegate:  procedure OnContextChanged(aEcmaScriptProvider: TDABaseEcmaScriptProvider; aEngine: TDAEcmaScriptEngine; aContext: IDAScriptContext; aServerContext: IDAServerScriptContext; IsSubscript: Boolean; aSubScript: string)

---

Fires when Error is happed.

property OnError: TDABaseEcmaScriptErrorEvent read write
delegate:  procedure OnError(aEcmaScriptProvider: TDABaseEcmaScriptProvider; aError: ScriptException)

---

Fires when script execute function LogMessage to log specified information.

property OnLog: TDABaseEcmaScriptLogEvent read write
delegate:  procedure OnLog(aEcmaScriptProvider: TDABaseEcmaScriptProvider; aMessage: string)