RemoteCommandRequest

Creates a new instance of the DynamicRequest class.

constructor

RemoteCommandRequest()

Sub New()

Creates a new instance of the DynamicRequest class and adds it to the providec components collection.

constructor(container: IContainer)

RemoteCommandRequest(IContainer container)

Sub New(container As IContainer)

Parameters:

• container: Components collection

Creates a new instance of the DynamicRequest class and sets its DynamicRequest and DynamicRequest properties.

constructor(methodName: String; remoteService: RemoteService)

RemoteCommandRequest(String methodName, RemoteService remoteService)

Sub New(methodName As String, remoteService As RemoteService)

Parameters:

• methodName: Remote method name
• remoteService: RemoteService class instance identifying the remote service

Creates a new instance of the DynamicRequest class and sets its DynamicRequest, DynamicRequest and DynamicRequest properties.

constructor(methodName: String; remoteService: RemoteService; parameters: array of DynamicRequestParameter)

RemoteCommandRequest(String methodName, RemoteService remoteService, DynamicRequestParameter[] parameters)

Sub New(methodName As String, remoteService As RemoteService, parameters As DynamicRequestParameter())

Parameters:

• methodName: Remote method name
• remoteService: RemoteService class instance identifying the remote service
• parameters: Parameters of the remote method call

Creates a new instance of the DynamicRequest class and sets its DynamicRequest, DynamicRequest and DynamicRequest properties.

constructor(methodName: String; remoteService: RemoteService; parameters: DynamicRequestParameterCollection)

RemoteCommandRequest(String methodName, RemoteService remoteService, DynamicRequestParameterCollection parameters)

Sub New(methodName As String, remoteService As RemoteService, parameters As DynamicRequestParameterCollection)

Parameters:

• methodName: Remote method name
• remoteService: RemoteService class instance identifying the remote service
• parameters: Parameters of the remote method call

Creates a new instance of the DynamicRequest class and sets its DynamicRequest, DynamicRequest and DynamicRequest properties.

constructor(methodName: String; remoteService: RemoteService; parameters: IList<DynamicRequestParameter>)

RemoteCommandRequest(String methodName, RemoteService remoteService, IList<DynamicRequestParameter> parameters)

Sub New(methodName As String, remoteService As RemoteService, parameters As IList<DynamicRequestParameter>)

Parameters:

• methodName: Remote method name
• remoteService: RemoteService class instance identifying the remote service
• parameters: Parameters of the remote method call

Asynchronously starts request to the remote service.

method BeginMakeRequest(cb: AsyncCallback; state: Object): IAsyncResult

IAsyncResult BeginMakeRequest(AsyncCallback cb, Object state)

Function BeginMakeRequest(cb As AsyncCallback, state As Object) As IAsyncResult

Parameters:

• cb: Callback method that will be called once the asynchronous operation is completed
• state: Asynchronous operation state object

Finishes the asynchronous request to the remote service.

method EndMakeRequest(ar: IAsyncResult)

void EndMakeRequest(IAsyncResult ar)

Sub EndMakeRequest(ar As IAsyncResult)

Parameters:

• ar: Object representing the status of an asynchronous operation

The name of the parameter that will return the affected rows to the client. When you change the names of the parameters of this dynamic request, you have to update this field to reflect your changes.

This must be a Int32 parameter.

property IncomingAffectedRowsParameter: String read write;

String IncomingAffectedRowsParameter { get; set; }

Property IncomingAffectedRowsParameter() As String

property IncomingParametersParameter: String read write;

String IncomingParametersParameter { get; set; }

Property IncomingParametersParameter() As String

Performs the actual request to the remote service.

method MakeRequest

void MakeRequest()

Sub MakeRequest()

Gets or sets the the name of the remote service method to call.

property MethodName: String read write;

String MethodName { get; set; }

Property MethodName() As String

Name of the parameter that will contain the name of the command to execute. When you change the names of the parameters of this dynamic request, you have to update this field to reflect your changes.

This must be a String parameter.

property OutgoingCommandNameParameter: String read write;

String OutgoingCommandNameParameter { get; set; }

Property OutgoingCommandNameParameter() As String

Name of the parameter that will contain all the parameters for the command. When you change the names of the parameters of this dynamic request, you have to update this field to reflect your changes.

This must be an "array of DataParameter" parameter.

property OutgoingParametersParameter: String read write;

String OutgoingParametersParameter { get; set; }

Property OutgoingParametersParameter() As String

property Owner: RemoteCommand read write;

RemoteCommand Owner { get; set; }

Property Owner() As RemoteCommand

Returns the DynamicRequestParameter with the given name.

This method can be used to populate all parameters with their values without relying on their ordering.

method ParameterByName(parameterName: String): DynamicRequestParameter

DynamicRequestParameter ParameterByName(String parameterName)

Function ParameterByName(parameterName As String) As DynamicRequestParameter

Parameters:

• parameterName: Parameter name

Gets collection of the parameters that will be passed into and out of the method call.

For the method call call to succeed these parameters have to exactly match the parameters defined for the service method on the server side.

The DynamicRequest and DynamicRequest methods can be used to populate the parameters automatically. Once the parameters are defined they an be accessed using the DynamicRequest method.

property Parameters: DynamicRequestParameterCollection read;

DynamicRequestParameterCollection Parameters { get; }

ReadOnly Property Parameters() As DynamicRequestParameterCollection

Reads parameter's value from the provided IMessage instance.

method ReadParameter(message: IMessage; parameter: DynamicRequestParameter)

void ReadParameter(IMessage message, DynamicRequestParameter parameter)

Sub ReadParameter(message As IMessage, parameter As DynamicRequestParameter)

Parameters:

• message: Message used to communicate with the server
• parameter: Method call parameter

Gets or sets the RemoteService class instance that defines the remote service to call.

property RemoteService: RemoteService read write;

RemoteService RemoteService { get; set; }

Property RemoteService() As RemoteService

Gets the parameter containing result of the remote method call.

property ResultParameter: DynamicRequestParameter read;

DynamicRequestParameter ResultParameter { get; }

ReadOnly Property ResultParameter() As DynamicRequestParameter

Sets or resets all parameters to the default settings needed when accessing a standard Data Abstract server implementing the IDataAbstractService. Note: This method automatically called when this class is initialized. Unless you are using Dynamic Method Binding or manually modifying the request's Parameters, the request will by default be set up correctly to talk to IDataAbstractService.

method SetupDefaultRequest

void SetupDefaultRequest()

Sub SetupDefaultRequest()

method SetupExtendedRequest

void SetupExtendedRequest()

Sub SetupExtendedRequest()

Retrieves the RODL from the server, locates the service and method and populates the DynamicRequest collection with the appropriate parameter definitions required for the remote method call. Any parameters or values defined prior to calling this method will be removed.

method UpdateParamsFromRodl

void UpdateParamsFromRodl()

Sub UpdateParamsFromRodl()

Populates the DynamicRequest collection with the appropriate parameter definitions required for the remote method call. Any parameters or values defined prior to calling this method will be removed.

Unlike the DynamicRequest method this method doesn't try to obtain the RODL from the server. Instead it takes the needed information from the provided RodlOperation instance.

method UpdateParamsFromRodlOperation(operation: RodlOperation)

void UpdateParamsFromRodlOperation(RodlOperation operation)

Sub UpdateParamsFromRodlOperation(operation As RodlOperation)

Parameters:

• operation: Server method definition

method Validate

void Validate()

Sub Validate()

Writes parameter name, type and value to the provided IMessage instance.

method WriteParameter(message: IMessage; parameter: DynamicRequestParameter)

void WriteParameter(IMessage message, DynamicRequestParameter parameter)

Sub WriteParameter(message As IMessage, parameter As DynamicRequestParameter)

Parameters:

• message: Message used to communicate with the server
• parameter: Remote method call parameter

The name of the parameter that will return the affected rows to the client. When you change the names of the parameters of this dynamic request, you have to update this field to reflect your changes.

This must be a Int32 parameter.

property IncomingAffectedRowsParameter: String read write;

String IncomingAffectedRowsParameter { get; set; }

Property IncomingAffectedRowsParameter() As String

property IncomingParametersParameter: String read write;

String IncomingParametersParameter { get; set; }

Property IncomingParametersParameter() As String

Gets or sets the the name of the remote service method to call.

property MethodName: String read write;

String MethodName { get; set; }

Property MethodName() As String

Name of the parameter that will contain the name of the command to execute. When you change the names of the parameters of this dynamic request, you have to update this field to reflect your changes.

This must be a String parameter.

property OutgoingCommandNameParameter: String read write;

String OutgoingCommandNameParameter { get; set; }

Property OutgoingCommandNameParameter() As String

Name of the parameter that will contain all the parameters for the command. When you change the names of the parameters of this dynamic request, you have to update this field to reflect your changes.

This must be an "array of DataParameter" parameter.

property OutgoingParametersParameter: String read write;

String OutgoingParametersParameter { get; set; }

Property OutgoingParametersParameter() As String

property Owner: RemoteCommand read write;

RemoteCommand Owner { get; set; }

Property Owner() As RemoteCommand

Gets collection of the parameters that will be passed into and out of the method call.

For the method call call to succeed these parameters have to exactly match the parameters defined for the service method on the server side.

The DynamicRequest and DynamicRequest methods can be used to populate the parameters automatically. Once the parameters are defined they an be accessed using the DynamicRequest method.

property Parameters: DynamicRequestParameterCollection read;

DynamicRequestParameterCollection Parameters { get; }

ReadOnly Property Parameters() As DynamicRequestParameterCollection

Gets or sets the RemoteService class instance that defines the remote service to call.

property RemoteService: RemoteService read write;

RemoteService RemoteService { get; set; }

Property RemoteService() As RemoteService

Gets the parameter containing result of the remote method call.

property ResultParameter: DynamicRequestParameter read;

DynamicRequestParameter ResultParameter { get; }

ReadOnly Property ResultParameter() As DynamicRequestParameter

Creates a new instance of the DynamicRequest class.

constructor

RemoteCommandRequest()

Sub New()

Creates a new instance of the DynamicRequest class and adds it to the providec components collection.

constructor(container: IContainer)

RemoteCommandRequest(IContainer container)

Sub New(container As IContainer)

Parameters:

• container: Components collection

Creates a new instance of the DynamicRequest class and sets its DynamicRequest and DynamicRequest properties.

constructor(methodName: String; remoteService: RemoteService)

RemoteCommandRequest(String methodName, RemoteService remoteService)

Sub New(methodName As String, remoteService As RemoteService)

Parameters:

• methodName: Remote method name
• remoteService: RemoteService class instance identifying the remote service

Creates a new instance of the DynamicRequest class and sets its DynamicRequest, DynamicRequest and DynamicRequest properties.

constructor(methodName: String; remoteService: RemoteService; parameters: array of DynamicRequestParameter)

RemoteCommandRequest(String methodName, RemoteService remoteService, DynamicRequestParameter[] parameters)

Sub New(methodName As String, remoteService As RemoteService, parameters As DynamicRequestParameter())

Parameters:

• methodName: Remote method name
• remoteService: RemoteService class instance identifying the remote service
• parameters: Parameters of the remote method call

Creates a new instance of the DynamicRequest class and sets its DynamicRequest, DynamicRequest and DynamicRequest properties.

constructor(methodName: String; remoteService: RemoteService; parameters: DynamicRequestParameterCollection)

RemoteCommandRequest(String methodName, RemoteService remoteService, DynamicRequestParameterCollection parameters)

Sub New(methodName As String, remoteService As RemoteService, parameters As DynamicRequestParameterCollection)

Parameters:

• methodName: Remote method name
• remoteService: RemoteService class instance identifying the remote service
• parameters: Parameters of the remote method call

Creates a new instance of the DynamicRequest class and sets its DynamicRequest, DynamicRequest and DynamicRequest properties.

constructor(methodName: String; remoteService: RemoteService; parameters: IList<DynamicRequestParameter>)

RemoteCommandRequest(String methodName, RemoteService remoteService, IList<DynamicRequestParameter> parameters)

Sub New(methodName As String, remoteService As RemoteService, parameters As IList<DynamicRequestParameter>)

Parameters:

• methodName: Remote method name
• remoteService: RemoteService class instance identifying the remote service
• parameters: Parameters of the remote method call

Asynchronously starts request to the remote service.

method BeginMakeRequest(cb: AsyncCallback; state: Object): IAsyncResult

IAsyncResult BeginMakeRequest(AsyncCallback cb, Object state)

Function BeginMakeRequest(cb As AsyncCallback, state As Object) As IAsyncResult

Parameters:

• cb: Callback method that will be called once the asynchronous operation is completed
• state: Asynchronous operation state object

Finishes the asynchronous request to the remote service.

method EndMakeRequest(ar: IAsyncResult)

void EndMakeRequest(IAsyncResult ar)

Sub EndMakeRequest(ar As IAsyncResult)

Parameters:

• ar: Object representing the status of an asynchronous operation

Performs the actual request to the remote service.

method MakeRequest

void MakeRequest()

Sub MakeRequest()

Returns the DynamicRequestParameter with the given name.

This method can be used to populate all parameters with their values without relying on their ordering.

method ParameterByName(parameterName: String): DynamicRequestParameter

DynamicRequestParameter ParameterByName(String parameterName)

Function ParameterByName(parameterName As String) As DynamicRequestParameter

Parameters:

• parameterName: Parameter name

Reads parameter's value from the provided IMessage instance.

method ReadParameter(message: IMessage; parameter: DynamicRequestParameter)

void ReadParameter(IMessage message, DynamicRequestParameter parameter)

Sub ReadParameter(message As IMessage, parameter As DynamicRequestParameter)

Parameters:

• message: Message used to communicate with the server
• parameter: Method call parameter

Sets or resets all parameters to the default settings needed when accessing a standard Data Abstract server implementing the IDataAbstractService. Note: This method automatically called when this class is initialized. Unless you are using Dynamic Method Binding or manually modifying the request's Parameters, the request will by default be set up correctly to talk to IDataAbstractService.

method SetupDefaultRequest

void SetupDefaultRequest()

Sub SetupDefaultRequest()

method SetupExtendedRequest

void SetupExtendedRequest()

Sub SetupExtendedRequest()

Retrieves the RODL from the server, locates the service and method and populates the DynamicRequest collection with the appropriate parameter definitions required for the remote method call. Any parameters or values defined prior to calling this method will be removed.

method UpdateParamsFromRodl

void UpdateParamsFromRodl()

Sub UpdateParamsFromRodl()

Populates the DynamicRequest collection with the appropriate parameter definitions required for the remote method call. Any parameters or values defined prior to calling this method will be removed.

Unlike the DynamicRequest method this method doesn't try to obtain the RODL from the server. Instead it takes the needed information from the provided RodlOperation instance.

method UpdateParamsFromRodlOperation(operation: RodlOperation)

void UpdateParamsFromRodlOperation(RodlOperation operation)

Sub UpdateParamsFromRodlOperation(operation As RodlOperation)

Parameters:

• operation: Server method definition

method Validate

void Validate()

Sub Validate()

Writes parameter name, type and value to the provided IMessage instance.

method WriteParameter(message: IMessage; parameter: DynamicRequestParameter)

void WriteParameter(IMessage message, DynamicRequestParameter parameter)

Sub WriteParameter(message As IMessage, parameter As DynamicRequestParameter)

Parameters:

• message: Message used to communicate with the server
• parameter: Remote method call parameter