TDADesigntimeCall

Overview

The TDADesigntimeCall visual component allows to invoke a remote function of a service during design time with a specified parameters collection. The parameters collection contains different types of items: fIn, fInOut, fOut and fResult. You can manipulate the collection of input parameters in designtime mode before executing the function on the server side. When double-clicking on the component, the method will be executed and the result will be stored in the same parameters collection. After execution, you can analyze the result in designtime mode.

Learn more about the TDADesigntimeCall visual component in the Authentication and application security (Delphi) article (begin from Design Time consideration when accessing services that have RequireSession set to "true").

Location

 

constructor Create  override    (declared in TRODynamicRequest)

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

Assign  override    (declared in TRODynamicRequest)

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

BeginExecute    (declared in TRODynamicRequest)

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

Parameters:

  • aCallback:
  • aUserData:

CheckProperties    (declared in TRODynamicRequest)

Validates the dynamic request properties.

procedure CheckProperties

CreateInputComplexTypes    (declared in TRODynamicRequest)

procedure CreateInputComplexTypes(SkipIfAssigned: boolean)

Parameters:

  • SkipIfAssigned:

DefaultNamespaces    (declared in TRODynamicRequest)

property DefaultNamespaces: TStringList read write

EndExecute    (declared in TRODynamicRequest)

procedure EndExecute(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

Execute    (declared in TRODynamicRequest)

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

procedure Execute(aParams: TRORequestParamCollection)

Parameters:

  • aParams: Parameters

FindParam    (declared in TRODynamicRequest)

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

IsFunction    (declared in TRODynamicRequest)

property IsFunction: boolean read write

ListServiceOperations    (declared in TRODynamicRequest)

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

Parameters:

  • aServiceName:
  • aList:

MakeRequest

Executes the remote function of a service during design time with a specified parameters collection and returns the result to the same parameters collection.

procedure MakeRequest

MethodName    (declared in TRODynamicRequest)

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

property MethodName: string read write

MethodNameChanged  protected virtual    (declared in TRODynamicRequest)

procedure MethodNameChanged

OnAfterExecute    (declared in TRODynamicRequest)

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)

OnBeforeExecute    (declared in 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)

OnChangeMethodName    (declared in TRODynamicRequest)

Fires when method name is changed

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

OnChangeServiceName    (declared in TRODynamicRequest)

Fires when service name is changed

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

OnExecuteError    (declared in TRODynamicRequest)

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)

OnFindCustomTypeImplementation    (declared in TRODynamicRequest)

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

ParamByName    (declared in TRODynamicRequest)

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

Params    (declared in TRODynamicRequest)

Contains the list of parameters used for the remote request, in form of a TRORequestParamCollection. Before executing the request, these parameters must be set to match the parameters expected by the server. If a RODL defining the method call is available at runtime, the CopyRODLOperation method can be used to automatically configure the parameter based on an operation defined in there.

property Params: TRORequestParamCollection read write

RefreshParams (boolean)  overload    (declared in TRODynamicRequest)

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.

RefreshParams (TRODLOperation, boolean)  overload    (declared in TRODynamicRequest)

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.

RemoteService    (declared in TRODynamicRequest)

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

property RemoteService: TRORemoteService read write

RODLLibrary    (declared in TRODynamicRequest)

property RODLLibrary: TRODLLibrary read write

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

 

DefaultNamespaces    (declared in TRODynamicRequest)

property DefaultNamespaces: TStringList read write

IsFunction    (declared in TRODynamicRequest)

property IsFunction: boolean read write

MethodName    (declared in TRODynamicRequest)

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

property MethodName: string read write

Params    (declared in TRODynamicRequest)

Contains the list of parameters used for the remote request, in form of a TRORequestParamCollection. Before executing the request, these parameters must be set to match the parameters expected by the server. If a RODL defining the method call is available at runtime, the CopyRODLOperation method can be used to automatically configure the parameter based on an operation defined in there.

property Params: TRORequestParamCollection read write

RemoteService    (declared in TRODynamicRequest)

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

property RemoteService: TRORemoteService read write

RODLLibrary    (declared in TRODynamicRequest)

property RODLLibrary: TRODLLibrary read write

 

constructor Create  override    (declared in TRODynamicRequest)

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

Assign  override    (declared in TRODynamicRequest)

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

BeginExecute    (declared in TRODynamicRequest)

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

Parameters:

  • aCallback:
  • aUserData:

CheckProperties    (declared in TRODynamicRequest)

Validates the dynamic request properties.

procedure CheckProperties

CreateInputComplexTypes    (declared in TRODynamicRequest)

procedure CreateInputComplexTypes(SkipIfAssigned: boolean)

Parameters:

  • SkipIfAssigned:

EndExecute    (declared in TRODynamicRequest)

procedure EndExecute(const aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

Execute    (declared in TRODynamicRequest)

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

procedure Execute(aParams: TRORequestParamCollection)

Parameters:

  • aParams: Parameters

FindParam    (declared in TRODynamicRequest)

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

ListServiceOperations    (declared in TRODynamicRequest)

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

Parameters:

  • aServiceName:
  • aList:

MakeRequest

Executes the remote function of a service during design time with a specified parameters collection and returns the result to the same parameters collection.

procedure MakeRequest

MethodNameChanged  protected virtual    (declared in TRODynamicRequest)

procedure MethodNameChanged

ParamByName    (declared in TRODynamicRequest)

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

RefreshParams (boolean)  overload    (declared in TRODynamicRequest)

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.

RefreshParams (TRODLOperation, boolean)  overload    (declared in TRODynamicRequest)

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.

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

 

OnAfterExecute    (declared in TRODynamicRequest)

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)

OnBeforeExecute    (declared in 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)

OnChangeMethodName    (declared in TRODynamicRequest)

Fires when method name is changed

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

OnChangeServiceName    (declared in TRODynamicRequest)

Fires when service name is changed

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

OnExecuteError    (declared in TRODynamicRequest)

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)

OnFindCustomTypeImplementation    (declared in TRODynamicRequest)

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

See Also

  • Authentication and application security (Delphi)