TDAGetSchemaRequest

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

function BeginExecute(const aCallback: TROAsyncCallback; const aUserData: Pointer): IROAsyncRequest

Parameters:

• aCallback:
• aUserData:

---

function BeginExecute(const aCallbackMethod: TROAsyncCallbackMethod; const aUserData: Pointer): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:

---

Validates the dynamic request properties.

procedure CheckProperties

---

procedure CreateInputComplexTypes(aSkipIfAssigned: Boolean)

Parameters:

• aSkipIfAssigned:

---

Indicates that default setup is used.

property Default: Boolean read write

---

property DefaultNamespaces: TStringList read

---

procedure EndExecute(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

Performs the remote request and executes the Service method on the server.

procedure Execute(aParams: TRORequestParamCollection)

Parameters:

• aParams: Parameters

---

Locates the TRORequestParam with a given name. If no parameter by that name is found, nil is returned.

function FindParam(const aParamName: string): TRORequestParam

Parameters:

• aParamName: Name of the parameter

---

Specifies the parameter that will contain the data received from the server. This parameter must be configured for all schema request calls as it will be used to obtain the actual schema information sent form the server. Depending on the used Data Streamer and server interface, this can be a Binary or String type; the legacy v3.0 server interface uses the data streamer to encode schema information, while the v4.0 interface will return the original XML schema.

property IncomingSchemaParameter: string read write

---

property IsFunction: Boolean read

---

Indicates that non-default setup is used.

function IsNotDefault: Boolean

---

procedure ListServiceOperations(const aServiceName: string; aList: TStrings)

Parameters:

• aServiceName:
• aList:

---

The name of the method to be executed on the server.

property MethodName: string read write

---

procedure MethodNameChanged

---

Forwards notification messages to all owned components.

procedure Notification(aComponent: TComponent; Operation: TOperation)

Parameters:

• aComponent: component
• Operation: operation

---

Fires just after the remote call has been executed (whether successfully or with an exception). You can use this event to inspect the returned Params, or to log execution.

property OnAfterExecute: TRODynamicRequestNotifyEvent read write
delegate:  procedure OnAfterExecute(Sender: TRODynamicRequest)

---

Fires just before the remote call is executed. You can use this event to make last changes to the list of Params, or to log execution.

property OnBeforeExecute: TRODynamicRequestNotifyEvent read write
delegate:  procedure OnBeforeExecute(Sender: TRODynamicRequest)

---

Fires when method name is changed

property OnChangeMethodName: TROStringPropertyChangeEvent read write
delegate:  procedure OnChangeMethodName(Sender: TRODynamicRequest; const OldValue: string; const NewValue: string)

---

Fires when service name is changed

property OnChangeServiceName: TROStringPropertyChangeEvent read write
delegate:  procedure OnChangeServiceName(Sender: TRODynamicRequest; const OldValue: string; const NewValue: string)

---

Fires if an exception was raised during the execution of the remote request (whether this was an exception sent back from the server, or a local one). You can use this event to inspect the raised exception, and optionally choose to not re-raise it, by setting the Ignore to true.

property OnExecuteError: TRODynamicRequestErrorEvent read write
delegate:  procedure OnExecuteError(Sender: TRODynamicRequest; Error: Exception; var Ignore: Boolean)

---

property OnFindCustomTypeImplementation: TROFindCustomTypeImplementationEvent read write
delegate:  procedure OnFindCustomTypeImplementation(Sender: TRODynamicRequest; const aTypeName: string; aParameter: TRORequestParam; out aImplementor: TROComplexType)

---

Defines a string parameter that can be used to transmit an optional filter string to the server, to limit the scope of the retrieved schema. This filter value is not used by the default service implementations, but can be evaluated by custom code (for example in the OnGetSchemaAsXMLEvent event) to restrict or modify the returned schema.

property OutgoingFilterParameter: string read write

---

Locates a specific parameter, based on its name. If no matching parameter is defined, an exception will be raised.

function ParamByName(const aParamName: string): TRORequestParam

Parameters:

• aParamName: Name of the parameter

---

Defines the parameters to pass to and receive from the call.

property Params: TRORequestParamCollection read write

---

Reloads the parameter definitions for the call. It allows to load the parameters from a specific RODL operation.

procedure RefreshParams(aOperation: TRODLOperation; aPersistValues: Boolean)

Parameters:

• aOperation: Operation
• aPersistValues: Allows to persist any values.

---

Reloads the parameter definitions for the call. It allows to automatically retrieve the RODL from the RemoteService and locate the operation based on the MethodName.

procedure RefreshParams(aPersistValues: Boolean)

Parameters:

• aPersistValues: Allows to persist any values.

---

Links to a TRORemoteService component that defines the service to be called.

property RemoteService: TRORemoteService read write

---

property RODLLibrary: TRODLLibrary read

---

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

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Resets to the default setup used for the new v4.0 service interface.

procedure SetupDefaultRequest

---

Resets to the default setup used for legacy v3.0 service interface.

procedure SetupDefaultRequestV3

 

Indicates that default setup is used.

property Default: Boolean read write

---

property DefaultNamespaces: TStringList read

---

Specifies the parameter that will contain the data received from the server. This parameter must be configured for all schema request calls as it will be used to obtain the actual schema information sent form the server. Depending on the used Data Streamer and server interface, this can be a Binary or String type; the legacy v3.0 server interface uses the data streamer to encode schema information, while the v4.0 interface will return the original XML schema.

property IncomingSchemaParameter: string read write

---

property IsFunction: Boolean read

---

The name of the method to be executed on the server.

property MethodName: string read write

---

Defines a string parameter that can be used to transmit an optional filter string to the server, to limit the scope of the retrieved schema. This filter value is not used by the default service implementations, but can be evaluated by custom code (for example in the OnGetSchemaAsXMLEvent event) to restrict or modify the returned schema.

property OutgoingFilterParameter: string read write

---

Defines the parameters to pass to and receive from the call.

property Params: TRORequestParamCollection read write

---

Links to a TRORemoteService component that defines the service to be called.

property RemoteService: TRORemoteService read write

---

property RODLLibrary: TRODLLibrary read

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

function BeginExecute(const aCallback: TROAsyncCallback; const aUserData: Pointer): IROAsyncRequest

Parameters:

• aCallback:
• aUserData:

---

function BeginExecute(const aCallbackMethod: TROAsyncCallbackMethod; const aUserData: Pointer): IROAsyncRequest

Parameters:

• aCallbackMethod:
• aUserData:

---

Validates the dynamic request properties.

procedure CheckProperties

---

procedure CreateInputComplexTypes(aSkipIfAssigned: Boolean)

Parameters:

• aSkipIfAssigned:

---

procedure EndExecute(const aRequest: IROAsyncRequest)

Parameters:

• aRequest:

---

Performs the remote request and executes the Service method on the server.

procedure Execute(aParams: TRORequestParamCollection)

Parameters:

• aParams: Parameters

---

Locates the TRORequestParam with a given name. If no parameter by that name is found, nil is returned.

function FindParam(const aParamName: string): TRORequestParam

Parameters:

• aParamName: Name of the parameter

---

Indicates that non-default setup is used.

function IsNotDefault: Boolean

---

procedure ListServiceOperations(const aServiceName: string; aList: TStrings)

Parameters:

• aServiceName:
• aList:

---

procedure MethodNameChanged

---

Forwards notification messages to all owned components.

procedure Notification(aComponent: TComponent; Operation: TOperation)

Parameters:

• aComponent: component
• Operation: operation

---

Locates a specific parameter, based on its name. If no matching parameter is defined, an exception will be raised.

function ParamByName(const aParamName: string): TRORequestParam

Parameters:

• aParamName: Name of the parameter

---

Reloads the parameter definitions for the call. It allows to load the parameters from a specific RODL operation.

procedure RefreshParams(aOperation: TRODLOperation; aPersistValues: Boolean)

Parameters:

• aOperation: Operation
• aPersistValues: Allows to persist any values.

---

Reloads the parameter definitions for the call. It allows to automatically retrieve the RODL from the RemoteService and locate the operation based on the MethodName.

procedure RefreshParams(aPersistValues: Boolean)

Parameters:

• aPersistValues: Allows to persist any values.

---

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

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Resets to the default setup used for the new v4.0 service interface.

procedure SetupDefaultRequest

---

Resets to the default setup used for legacy v3.0 service interface.

procedure SetupDefaultRequestV3

 

Fires just after the remote call has been executed (whether successfully or with an exception). You can use this event to inspect the returned Params, or to log execution.

property OnAfterExecute: TRODynamicRequestNotifyEvent read write
delegate:  procedure OnAfterExecute(Sender: TRODynamicRequest)

---

Fires just before the remote call is executed. You can use this event to make last changes to the list of Params, or to log execution.

property OnBeforeExecute: TRODynamicRequestNotifyEvent read write
delegate:  procedure OnBeforeExecute(Sender: TRODynamicRequest)

---

Fires when method name is changed

property OnChangeMethodName: TROStringPropertyChangeEvent read write
delegate:  procedure OnChangeMethodName(Sender: TRODynamicRequest; const OldValue: string; const NewValue: string)

---

Fires when service name is changed

property OnChangeServiceName: TROStringPropertyChangeEvent read write
delegate:  procedure OnChangeServiceName(Sender: TRODynamicRequest; const OldValue: string; const NewValue: string)

---

Fires if an exception was raised during the execution of the remote request (whether this was an exception sent back from the server, or a local one). You can use this event to inspect the raised exception, and optionally choose to not re-raise it, by setting the Ignore to true.

property OnExecuteError: TRODynamicRequestErrorEvent read write
delegate:  procedure OnExecuteError(Sender: TRODynamicRequest; Error: Exception; var Ignore: Boolean)

---

property OnFindCustomTypeImplementation: TROFindCustomTypeImplementationEvent read write
delegate:  procedure OnFindCustomTypeImplementation(Sender: TRODynamicRequest; const aTypeName: string; aParameter: TRORequestParam; out aImplementor: TROComplexType)