TDAGetDataRequest

Overview

Configures the server request that will be executed by the TDARemoteDataAdapter to retrieve data from the server.

Location

 

constructor Create  override    (declared in TDARemoteDataAdapterRequest)

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

Assign  override

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:

Default    (declared in TDARemoteDataAdapterRequest)

Indicates that default setup is used.

property Default: boolean read write

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

IncomingDataParameter

Specifies the parameter that will contain the data received from the server. This parameter must be configured for all data request calls as it will be used to obtain the actual data sent form the server. Depending on the used Data Streamer , this can be a Binary or String type.

property IncomingDataParameter: string read write

IsFunction    (declared in TRODynamicRequest)

property IsFunction: boolean read write

IsNotDefault  protected    (declared in TDARemoteDataAdapterRequest)

Indicates that non-default setup is used.

function IsNotDefault: boolean

ListServiceOperations    (declared in TRODynamicRequest)

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

Parameters:

  • aServiceName:
  • aList:

MethodName    (declared in TDARemoteDataAdapterRequest)

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

property MethodName:

MethodNameChanged  protected override    (declared in TDARemoteDataAdapterRequest)

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)

OutgoingIncludeSchemaParameter

Sets the Boolean parameter that will indicate whether to include schema information in the retrieved data, or not. This parameter is used by the legacy v3.0 server interface only.

property OutgoingIncludeSchemaParameter: string read write

OutgoingMaxRecordsParameter

This integer parameter will indicate the maximum number of records to retrieve. This parameter is used by the legacy v3.0 server interface only.

property OutgoingMaxRecordsParameter: string read write

OutgoingParamsParameter

Name of the parameter that takes array of TDADatasetParam structs to send any required parameters for the retrieved data table. This parameter is used by the legacy v3.0 server interface only, and needs to be configured only if parameters need to be passed.

property OutgoingParamsParameter: string read write

OutgoingTableNamesParameter

Defines the parameter for the name or names of the tables to retrieve from the server. This parameter must be configured for all data request. Depending on the server interface, this can be a string or an array of strings. The v3.0 server interfaces uses a string and can only receive one table at a time, while the new v4.0 interface expects an array of strings.

property OutgoingTableNamesParameter: string read write

OutgoingTableRequestInfosParameter

Specifies the parameter that takes array of TableRequestInfo to provide additional options for the data retrieval of each table. This parameter is used by the v4.0 server interface only.

property OutgoingTableRequestInfosParameter: string read write

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

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

property Params:

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

SetupDefaultRequest  override

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

procedure SetupDefaultRequest

SetupDefaultRequestV3  override

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

procedure SetupDefaultRequestV3

 

Default    (declared in TDARemoteDataAdapterRequest)

Indicates that default setup is used.

property Default: boolean read write

DefaultNamespaces    (declared in TRODynamicRequest)

property DefaultNamespaces: TStringList read write

IncomingDataParameter

Specifies the parameter that will contain the data received from the server. This parameter must be configured for all data request calls as it will be used to obtain the actual data sent form the server. Depending on the used Data Streamer , this can be a Binary or String type.

property IncomingDataParameter: string read write

IsFunction    (declared in TRODynamicRequest)

property IsFunction: boolean read write

MethodName    (declared in TDARemoteDataAdapterRequest)

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

property MethodName:

OutgoingIncludeSchemaParameter

Sets the Boolean parameter that will indicate whether to include schema information in the retrieved data, or not. This parameter is used by the legacy v3.0 server interface only.

property OutgoingIncludeSchemaParameter: string read write

OutgoingMaxRecordsParameter

This integer parameter will indicate the maximum number of records to retrieve. This parameter is used by the legacy v3.0 server interface only.

property OutgoingMaxRecordsParameter: string read write

OutgoingParamsParameter

Name of the parameter that takes array of TDADatasetParam structs to send any required parameters for the retrieved data table. This parameter is used by the legacy v3.0 server interface only, and needs to be configured only if parameters need to be passed.

property OutgoingParamsParameter: string read write

OutgoingTableNamesParameter

Defines the parameter for the name or names of the tables to retrieve from the server. This parameter must be configured for all data request. Depending on the server interface, this can be a string or an array of strings. The v3.0 server interfaces uses a string and can only receive one table at a time, while the new v4.0 interface expects an array of strings.

property OutgoingTableNamesParameter: string read write

OutgoingTableRequestInfosParameter

Specifies the parameter that takes array of TableRequestInfo to provide additional options for the data retrieval of each table. This parameter is used by the v4.0 server interface only.

property OutgoingTableRequestInfosParameter: string read write

Params    (declared in TDARemoteDataAdapterRequest)

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

property Params:

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

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

Assign  override

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

IsNotDefault  protected    (declared in TDARemoteDataAdapterRequest)

Indicates that non-default setup is used.

function IsNotDefault: boolean

ListServiceOperations    (declared in TRODynamicRequest)

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

Parameters:

  • aServiceName:
  • aList:

MethodNameChanged  protected override    (declared in TDARemoteDataAdapterRequest)

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

SetupDefaultRequest  override

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

procedure SetupDefaultRequest

SetupDefaultRequestV3  override

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

procedure SetupDefaultRequestV3

 

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