SchemaRequest

Overview

SchemaRequest is used by Data Abstract to request the schema for a Data Abstract service from the server without requiring an _Intf file to invoke it. This class makes use of the Remoting SDK DynamicRequest support.

Location

 

constructor    (declared in DynamicRequest)

Creates a new instance of the DynamicRequest class.

 

constructor

 

SchemaRequest()

 

Sub New()

constructor (IContainer)    (declared in DynamicRequest)

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

 

constructor(container: IContainer)

 

SchemaRequest(IContainer container)

 

Sub New(container As IContainer)

Parameters:

  • container: Components collection

constructor (String, RemoteService)    (declared in DynamicRequest)

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

 

constructor(methodName: String; remoteService: RemoteService)

 

SchemaRequest(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

constructor (String, RemoteService, array of DynamicRequestParameter)    (declared in DynamicRequest)

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)

 

SchemaRequest(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

constructor (String, RemoteService, DynamicRequestParameterCollection)    (declared in DynamicRequest)

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

 

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

 

SchemaRequest(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

constructor (String, RemoteService, IList<DynamicRequestParameter>)    (declared in DynamicRequest)

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

 

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

 

SchemaRequest(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

constructor (BaseDataAdapter)

Default constructor for SchemaRequest.

 

constructor(owner: BaseDataAdapter)

 

SchemaRequest(BaseDataAdapter owner)

 

Sub New(owner As BaseDataAdapter)

Parameters:

  • owner:

BeginMakeRequest    (declared in DynamicRequest)

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

EndMakeRequest    (declared in DynamicRequest)

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

IncomingSchemaParameter

The Name of the parameter in which the server will return the schema XML for the Data Abstract service. This must be a String parameter.

 

property IncomingSchemaParameter: String read write;

 

String IncomingSchemaParameter { get; set; }

 

Property IncomingSchemaParameter() As String

MakeRequest    (declared in DynamicRequest)

Performs the actual request to the remote service.

 

method MakeRequest

 

void MakeRequest()

 

Sub MakeRequest()

MethodName    (declared in DynamicRequest)

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

Note: If the DynamicRequest property is assigned and the server is available at design time, you can select the method name from a list of available methods in the Property Browser's drop down box. When doing this, the DynamicRequest collection will automatically be populated as well.

 

property MethodName: String read write;

 

String MethodName { get; set; }

 

Property MethodName() As String

OutgoingFilterParameter

 

property OutgoingFilterParameter: String read write;

 

String OutgoingFilterParameter { get; set; }

 

Property OutgoingFilterParameter() As String

Owner    (declared in RemoteDataAdapterRequest)

 

property Owner: BaseDataAdapter read write;

 

BaseDataAdapter Owner { get; set; }

 

Property Owner() As BaseDataAdapter

ParameterByName    (declared in DynamicRequest)

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

Parameters    (declared in DynamicRequest)

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.

Note: If the DynamicRequest property is assigned and the server is available at design time, you can select the method name from a list of available methods in the Property Browser's drop down box. When doing this, the DynamicRequest collection will automatically be populated as well.

 

property Parameters: DynamicRequestParameterCollection read;

 

DynamicRequestParameterCollection Parameters { get; }

 

ReadOnly Property Parameters() As DynamicRequestParameterCollection

ReadParameter  protected    (declared in DynamicRequest)

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

RemoteService    (declared in DynamicRequest)

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

ResultParameter    (declared in DynamicRequest)

Gets the parameter containing result of the remote method call.

 

property ResultParameter: DynamicRequestParameter read;

 

DynamicRequestParameter ResultParameter { get; }

 

ReadOnly Property ResultParameter() As DynamicRequestParameter

SetupDefaultRequest

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

 

method SetupDefaultRequest

 

void SetupDefaultRequest()

 

Sub SetupDefaultRequest()

UpdateParamsFromRodl    (declared in DynamicRequest)

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()

UpdateParamsFromRodlOperation

 

method UpdateParamsFromRodlOperation(operation: RodlOperation)

 

void UpdateParamsFromRodlOperation(RodlOperation operation)

 

Sub UpdateParamsFromRodlOperation(operation As RodlOperation)

Parameters:

  • operation:

Validate

 

method Validate

 

void Validate()

 

Sub Validate()

WriteParameter  protected    (declared in DynamicRequest)

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

 

IncomingSchemaParameter

The Name of the parameter in which the server will return the schema XML for the Data Abstract service. This must be a String parameter.

 

property IncomingSchemaParameter: String read write;

 

String IncomingSchemaParameter { get; set; }

 

Property IncomingSchemaParameter() As String

MethodName    (declared in DynamicRequest)

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

Note: If the DynamicRequest property is assigned and the server is available at design time, you can select the method name from a list of available methods in the Property Browser's drop down box. When doing this, the DynamicRequest collection will automatically be populated as well.

 

property MethodName: String read write;

 

String MethodName { get; set; }

 

Property MethodName() As String

OutgoingFilterParameter

 

property OutgoingFilterParameter: String read write;

 

String OutgoingFilterParameter { get; set; }

 

Property OutgoingFilterParameter() As String

Owner    (declared in RemoteDataAdapterRequest)

 

property Owner: BaseDataAdapter read write;

 

BaseDataAdapter Owner { get; set; }

 

Property Owner() As BaseDataAdapter

Parameters    (declared in DynamicRequest)

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.

Note: If the DynamicRequest property is assigned and the server is available at design time, you can select the method name from a list of available methods in the Property Browser's drop down box. When doing this, the DynamicRequest collection will automatically be populated as well.

 

property Parameters: DynamicRequestParameterCollection read;

 

DynamicRequestParameterCollection Parameters { get; }

 

ReadOnly Property Parameters() As DynamicRequestParameterCollection

RemoteService    (declared in DynamicRequest)

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

ResultParameter    (declared in DynamicRequest)

Gets the parameter containing result of the remote method call.

 

property ResultParameter: DynamicRequestParameter read;

 

DynamicRequestParameter ResultParameter { get; }

 

ReadOnly Property ResultParameter() As DynamicRequestParameter

 

constructor    (declared in DynamicRequest)

Creates a new instance of the DynamicRequest class.

 

constructor

 

SchemaRequest()

 

Sub New()

constructor (IContainer)    (declared in DynamicRequest)

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

 

constructor(container: IContainer)

 

SchemaRequest(IContainer container)

 

Sub New(container As IContainer)

Parameters:

  • container: Components collection

constructor (String, RemoteService)    (declared in DynamicRequest)

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

 

constructor(methodName: String; remoteService: RemoteService)

 

SchemaRequest(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

constructor (String, RemoteService, array of DynamicRequestParameter)    (declared in DynamicRequest)

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)

 

SchemaRequest(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

constructor (String, RemoteService, DynamicRequestParameterCollection)    (declared in DynamicRequest)

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

 

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

 

SchemaRequest(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

constructor (String, RemoteService, IList<DynamicRequestParameter>)    (declared in DynamicRequest)

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

 

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

 

SchemaRequest(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

constructor (BaseDataAdapter)

Default constructor for SchemaRequest.

 

constructor(owner: BaseDataAdapter)

 

SchemaRequest(BaseDataAdapter owner)

 

Sub New(owner As BaseDataAdapter)

Parameters:

  • owner:

BeginMakeRequest    (declared in DynamicRequest)

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

EndMakeRequest    (declared in DynamicRequest)

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

MakeRequest    (declared in DynamicRequest)

Performs the actual request to the remote service.

 

method MakeRequest

 

void MakeRequest()

 

Sub MakeRequest()

ParameterByName    (declared in DynamicRequest)

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

ReadParameter  protected    (declared in DynamicRequest)

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

SetupDefaultRequest

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

 

method SetupDefaultRequest

 

void SetupDefaultRequest()

 

Sub SetupDefaultRequest()

UpdateParamsFromRodl    (declared in DynamicRequest)

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()

UpdateParamsFromRodlOperation

 

method UpdateParamsFromRodlOperation(operation: RodlOperation)

 

void UpdateParamsFromRodlOperation(RodlOperation operation)

 

Sub UpdateParamsFromRodlOperation(operation As RodlOperation)

Parameters:

  • operation:

Validate

 

method Validate

 

void Validate()

 

Sub Validate()

WriteParameter  protected    (declared in DynamicRequest)

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