DynamicRequest Class
From RemObjects Software
This is a Data Abstract Architecture entry
Feel free to add your notes to this topic below.
Overview (.NET)
Used to represent a request, or method call, that can be made to a service on a RemObjects SDK Server.
In contrast to making calls in code that use the services imported interfaces, DynamicRequest allows you to make calls to services whose exact definition is not know at compile time.
The service to be called into is identified by the referenced RemoteService component, while the call itself is defined through the MethodName and Parameters properties.
Once a call has been set up and the required parameter values have been specified, the call can be executed by calling the MakeRequest method.
This component is a part of Data Abstract, however the namespace is called RemObjects.SDK. It iscontained in DataAbstract.dll.
Namespace
Declaration (C#)
[ToolboxBitmap(typeof(DesigntimeConsts), "Glyphs.DynamicRequest.bmp")] public class DynamicRequest : BaseComponent;
Hierarchy
- Component
- RemObjects.Common.BaseComponent
- RemObjects.SDK.DynamicRequest
- RemObjects.Common.BaseComponent
Properties
| | | |
|---|---|---|
| MethodName | String | Specifies the name of the method to call.
Note: If the RemoteService 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 Parameters collection will automatically be populated. |
| Parameters | DynamicRequestParameterCollection | Defines the parameters that get passed into and out of the method call.
For your call to succeed, this must match exactly the parameters defined for your method, and you can use the UpdateParamsFromRodl and UpdateParamsFromRodlOperation methods to populate the parameters automatically. Once the parameters are defined, you can set their values using ParameterByName("Name").Value before you make your call. Note: If the RemoteService 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 Parameters collection will automatically be populated. |
| RemoteService | RemoteService | References the RemoteService component that defines the service to call. |
Methods
| | |
|---|---|
| DynamicRequest | Default constructor for DynamicRequest. |
| MakeRequest | Performs the actual request to the remote service. |
| ParameterByName | Returns the DynamicRequestParameter of a given name.
You can use this method to conveniently populate all parameters with their proper values without relying on their ordering, as shown in the example below. |
| UpdateParamsFromRodl | Retrieves the RODL file from the server, locates the service and method, and populates the Parameters collection with the appropriate parameters needed for the method call.
Any parameters or values defined prior to calling UpdateParamsFromRodl will be lost. |
| UpdateParamsFromRodlOperation | Populates the Parameters collection with the appropriate parameters needed for the method call.
In contrast to UpdateParamsFromRodl, it will not try to obtain the RODL file from the server, but work with the passed RodlOperation instance. Any parameters or values defined prior to calling UpdateParamsFromRodlOperation will be lost. |
See Also
Product: RemObjects Data Abstract
Current version: Data Abstract 'Vinci' (5.0)
Lists — Glossary — Features — How To — Drivers — Components — Tools — Samples — Articles — Architecture — Issues
Categories: Text | Data Abstract | Architecture | Class | .NET
