RemoteCommand

Overview

Provides the ability to dynamically invoke a Command from the server's Schema.

By default, the standard DataAbstractService class is configured to prevent execution of arbitrary commands from the client, as this poses a possible security risk, depending on what kind of commands are defined on your schema.

To enable execution of commands form the client, set the AllowExecuteCommand property of your DataAbstractService to true and ensure that all published Commands in your schema are safe for execution. Also, you need to have proper authentication methods in place to prevent anonymous users from making malicious calls.

Location

 

constructor

Creates a new instance

 

constructor

 

RemoteCommand()

 

Sub New()

constructor (IContainer)

Creates a new instance

 

constructor(container: IContainer)

 

RemoteCommand(IContainer container)

 

Sub New(container As IContainer)

Parameters:

  • container:

AfterExecuteCommand

 

event AfterExecuteCommand: EventHandler<RemoteCommandAfteExecuteEventArgs>

 

delegate EventHandler<RemoteCommandAfteExecuteEventArgs> AfterExecuteCommand()

 

Event AfterExecuteCommand As EventHandler<RemoteCommandAfteExecuteEventArgs>

BeforeExecuteCommand

 

event BeforeExecuteCommand: EventHandler<RemoteCommandEventArgs>

 

delegate EventHandler<RemoteCommandEventArgs> BeforeExecuteCommand()

 

Event BeforeExecuteCommand As EventHandler<RemoteCommandEventArgs>

CATEGORY_COMMUNICATION  protected    (declared in BaseCommand)

 

const CATEGORY_COMMUNICATION: String = 'Communication'

 

const String CATEGORY_COMMUNICATION = "Communication"

 

Const CATEGORY_COMMUNICATION As String = "Communication"

CATEGORY_DYNAMIC_METHOD_BINDING  protected    (declared in BaseCommand)

 

const CATEGORY_DYNAMIC_METHOD_BINDING: String = 'Dynamic Method Binding'

 

const String CATEGORY_DYNAMIC_METHOD_BINDING = "Dynamic Method Binding"

 

Const CATEGORY_DYNAMIC_METHOD_BINDING As String = "Dynamic Method Binding"

CATEGORY_OPTIONS  protected    (declared in BaseCommand)

 

const CATEGORY_OPTIONS: String = 'Options'

 

const String CATEGORY_OPTIONS = "Options"

 

Const CATEGORY_OPTIONS As String = "Options"

CATEGORY_STREAMING  protected    (declared in BaseCommand)

 

const CATEGORY_STREAMING: String = 'Streaming'

 

const String CATEGORY_STREAMING = "Streaming"

 

Const CATEGORY_STREAMING As String = "Streaming"

Execute (String): Int32    (declared in BaseCommand)

Executes the command with the given name and returns the number of affected rows.

 

method Execute(commandName: String): Int32

 

Int32 Execute(String commandName)

 

Function Execute(commandName As String) As Int32

Parameters:

  • commandName: Name of the command that is declared in the schema.

Execute (String, array of String, array of Object): Int32    (declared in BaseCommand)

Executes the command with the given name and input parameters and returns the number of affected rows.

 

method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object): Int32

 

Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues)

 

Function Execute(commandName As String, parameterNames As String(), parameterValues As Object()) As Int32

Parameters:

  • commandName: Name of the command that is declared in the schema.
  • parameterNames: Specified array with input parameter names
  • parameterValues: specified array with input parameter values.

Execute (String, array of String, array of Object, String, Object): Int32    (declared in BaseCommand)

Executes the command with the given name and input parameters and returns the number of affected rows and output parameters.

 

method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object; out outputNames: String; out outputValues: Object): Int32

 

Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues, out String outputNames, out Object outputValues)

 

Function Execute(commandName As String, parameterNames As String(), parameterValues As Object(), <OutAttribute> ByRef outputNames As String, <OutAttribute> ByRef outputValues As Object) As Int32

Parameters:

  • commandName: Name of the command that is declared in the schema.
  • parameterNames: Specified array with input parameter names
  • parameterValues: specified array with input parameter values.
  • outputNames: Specified array with output parameter names
  • outputValues: specified array with output parameter values.

Execute (String, array of DataParameter): Int32    (declared in BaseCommand)

Executes the command with the given name and input parameters and returns the number of affected rows.

 

method Execute(commandName: String; parameters: array of DataParameter): Int32

 

Int32 Execute(String commandName, DataParameter[] parameters)

 

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

Parameters:

  • commandName: Name of the command that is declared in the schema.
  • parameters: Specified array with input parameters.

Execute (String, array of DataParameter, DataParameter): Int32    (declared in BaseCommand)

Executes the command with the given name and input parameters and returns the number of affected rows and output parameters.

 

method Execute(commandName: String; parameters: array of DataParameter; out output: DataParameter): Int32

 

Int32 Execute(String commandName, DataParameter[] parameters, out DataParameter output)

 

Function Execute(commandName As String, parameters As DataParameter(), <OutAttribute> ByRef output As DataParameter) As Int32

Parameters:

  • commandName: Name of the command that is declared in the schema.
  • parameters: Specified array with input parameters.
  • output: Specified array with output parameters.

Execute (String, array of Object): Int32    (declared in BaseCommand)

Executes the command with the given input parameters and returns the number of affected rows.

 

method Execute(commandName: String; parameterValues: array of Object): Int32

 

Int32 Execute(String commandName, Object[] parameterValues)

 

Function Execute(commandName As String, parameterValues As Object()) As Int32

Parameters:

  • commandName: Name of the command that is declared in the schema.
  • parameterValues: specified array with input parameter values.

ExecuteCall

The DynamicRequest that will be used to invoke the Command on the server. By default, it will be mapped to the ExecuteCommand call as defined in the IDataAbstractService implemented by standard Data Abstract 4.0 servers. When using a custom server interface, you can change its sub-properties to control how the data update call is made.

 

property ExecuteCall: RemoteCommandRequest read;

 

RemoteCommandRequest ExecuteCall { get; }

 

ReadOnly Property ExecuteCall() As RemoteCommandRequest

RemoteService

References the RemoteService component that defines the service to call for executing the command.

 

property RemoteService: RemoteService read write;

 

RemoteService RemoteService { get; set; }

 

Property RemoteService() As RemoteService

TriggerAfterExecuteCommand  protected

 

method TriggerAfterExecuteCommand(e: RemoteCommandAfteExecuteEventArgs)

 

void TriggerAfterExecuteCommand(RemoteCommandAfteExecuteEventArgs e)

 

Sub TriggerAfterExecuteCommand(e As RemoteCommandAfteExecuteEventArgs)

Parameters:

  • e:

TriggerBeforeExecuteCommand  protected

 

method TriggerBeforeExecuteCommand(e: RemoteCommandEventArgs)

 

void TriggerBeforeExecuteCommand(RemoteCommandEventArgs e)

 

Sub TriggerBeforeExecuteCommand(e As RemoteCommandEventArgs)

Parameters:

  • e:

 

CATEGORY_COMMUNICATION  protected    (declared in BaseCommand)

 

const CATEGORY_COMMUNICATION: String = 'Communication'

 

const String CATEGORY_COMMUNICATION = "Communication"

 

Const CATEGORY_COMMUNICATION As String = "Communication"

CATEGORY_DYNAMIC_METHOD_BINDING  protected    (declared in BaseCommand)

 

const CATEGORY_DYNAMIC_METHOD_BINDING: String = 'Dynamic Method Binding'

 

const String CATEGORY_DYNAMIC_METHOD_BINDING = "Dynamic Method Binding"

 

Const CATEGORY_DYNAMIC_METHOD_BINDING As String = "Dynamic Method Binding"

CATEGORY_OPTIONS  protected    (declared in BaseCommand)

 

const CATEGORY_OPTIONS: String = 'Options'

 

const String CATEGORY_OPTIONS = "Options"

 

Const CATEGORY_OPTIONS As String = "Options"

CATEGORY_STREAMING  protected    (declared in BaseCommand)

 

const CATEGORY_STREAMING: String = 'Streaming'

 

const String CATEGORY_STREAMING = "Streaming"

 

Const CATEGORY_STREAMING As String = "Streaming"

 

ExecuteCall

The DynamicRequest that will be used to invoke the Command on the server. By default, it will be mapped to the ExecuteCommand call as defined in the IDataAbstractService implemented by standard Data Abstract 4.0 servers. When using a custom server interface, you can change its sub-properties to control how the data update call is made.

 

property ExecuteCall: RemoteCommandRequest read;

 

RemoteCommandRequest ExecuteCall { get; }

 

ReadOnly Property ExecuteCall() As RemoteCommandRequest

RemoteService

References the RemoteService component that defines the service to call for executing the command.

 

property RemoteService: RemoteService read write;

 

RemoteService RemoteService { get; set; }

 

Property RemoteService() As RemoteService

 

constructor

Creates a new instance

 

constructor

 

RemoteCommand()

 

Sub New()

constructor (IContainer)

Creates a new instance

 

constructor(container: IContainer)

 

RemoteCommand(IContainer container)

 

Sub New(container As IContainer)

Parameters:

  • container:

Execute (String): Int32    (declared in BaseCommand)

Executes the command with the given name and returns the number of affected rows.

 

method Execute(commandName: String): Int32

 

Int32 Execute(String commandName)

 

Function Execute(commandName As String) As Int32

Parameters:

  • commandName: Name of the command that is declared in the schema.

Execute (String, array of String, array of Object): Int32    (declared in BaseCommand)

Executes the command with the given name and input parameters and returns the number of affected rows.

 

method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object): Int32

 

Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues)

 

Function Execute(commandName As String, parameterNames As String(), parameterValues As Object()) As Int32

Parameters:

  • commandName: Name of the command that is declared in the schema.
  • parameterNames: Specified array with input parameter names
  • parameterValues: specified array with input parameter values.

Execute (String, array of String, array of Object, String, Object): Int32    (declared in BaseCommand)

Executes the command with the given name and input parameters and returns the number of affected rows and output parameters.

 

method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object; out outputNames: String; out outputValues: Object): Int32

 

Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues, out String outputNames, out Object outputValues)

 

Function Execute(commandName As String, parameterNames As String(), parameterValues As Object(), <OutAttribute> ByRef outputNames As String, <OutAttribute> ByRef outputValues As Object) As Int32

Parameters:

  • commandName: Name of the command that is declared in the schema.
  • parameterNames: Specified array with input parameter names
  • parameterValues: specified array with input parameter values.
  • outputNames: Specified array with output parameter names
  • outputValues: specified array with output parameter values.

Execute (String, array of DataParameter): Int32    (declared in BaseCommand)

Executes the command with the given name and input parameters and returns the number of affected rows.

 

method Execute(commandName: String; parameters: array of DataParameter): Int32

 

Int32 Execute(String commandName, DataParameter[] parameters)

 

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

Parameters:

  • commandName: Name of the command that is declared in the schema.
  • parameters: Specified array with input parameters.

Execute (String, array of DataParameter, DataParameter): Int32    (declared in BaseCommand)

Executes the command with the given name and input parameters and returns the number of affected rows and output parameters.

 

method Execute(commandName: String; parameters: array of DataParameter; out output: DataParameter): Int32

 

Int32 Execute(String commandName, DataParameter[] parameters, out DataParameter output)

 

Function Execute(commandName As String, parameters As DataParameter(), <OutAttribute> ByRef output As DataParameter) As Int32

Parameters:

  • commandName: Name of the command that is declared in the schema.
  • parameters: Specified array with input parameters.
  • output: Specified array with output parameters.

Execute (String, array of Object): Int32    (declared in BaseCommand)

Executes the command with the given input parameters and returns the number of affected rows.

 

method Execute(commandName: String; parameterValues: array of Object): Int32

 

Int32 Execute(String commandName, Object[] parameterValues)

 

Function Execute(commandName As String, parameterValues As Object()) As Int32

Parameters:

  • commandName: Name of the command that is declared in the schema.
  • parameterValues: specified array with input parameter values.

TriggerAfterExecuteCommand  protected

 

method TriggerAfterExecuteCommand(e: RemoteCommandAfteExecuteEventArgs)

 

void TriggerAfterExecuteCommand(RemoteCommandAfteExecuteEventArgs e)

 

Sub TriggerAfterExecuteCommand(e As RemoteCommandAfteExecuteEventArgs)

Parameters:

  • e:

TriggerBeforeExecuteCommand  protected

 

method TriggerBeforeExecuteCommand(e: RemoteCommandEventArgs)

 

void TriggerBeforeExecuteCommand(RemoteCommandEventArgs e)

 

Sub TriggerBeforeExecuteCommand(e As RemoteCommandEventArgs)

Parameters:

  • e:

 

AfterExecuteCommand

 

event AfterExecuteCommand: EventHandler<RemoteCommandAfteExecuteEventArgs>

 

delegate EventHandler<RemoteCommandAfteExecuteEventArgs> AfterExecuteCommand()

 

Event AfterExecuteCommand As EventHandler<RemoteCommandAfteExecuteEventArgs>

BeforeExecuteCommand

 

event BeforeExecuteCommand: EventHandler<RemoteCommandEventArgs>

 

delegate EventHandler<RemoteCommandEventArgs> BeforeExecuteCommand()

 

Event BeforeExecuteCommand As EventHandler<RemoteCommandEventArgs>