TRORequestParamCollection

Overview

The TRORequestParamCollection class is used to represent the list of parameters for a TRODynamicRequest.

Use Case

You will usually not create instances of this class yourself, but work with the Params property of a TRODynamicRequest component.

Location

 

constructor Create

Creates a new instance.

constructor Create(aDynamicRequest: TRODynamicRequest)

Parameters:

  • aDynamicRequest:

Add  overload

function Add: TRORequestParam

Add (string, TRODataType, TRODLParamFlag, string): TRORequestParam  overload

function Add(const aName: string; aDataType: TRODataType; aParamFlag: TRODLParamFlag; const aTypeName: string): TRORequestParam

Parameters:

  • aName:
  • aDataType:
  • aParamFlag:
  • aTypeName:

ClearInputValues

procedure ClearInputValues

ClearOutputValues

procedure ClearOutputValues

ClearValues

procedure ClearValues

Clone

procedure Clone(Source: TRORequestParamCollection)

Parameters:

  • Source:

CopyRODLOperation

procedure CopyRODLOperation(anOperation: TRODLOperation)

Parameters:

  • anOperation:

FindParam

Locates the TRORequestParam with a given name.

function FindParam(const aParamName: string): TRORequestParam

Parameters:

  • aParamName: Name of the parameter

HasResultParam

Returns whether the collection contains a parameter marked as fResult. Any request may only contain zero or one parameter marked as result - any other parameters returned from the server must use the fOut flag, instead.

property HasResultParam: boolean read write

IndexOf

Returns the position of a aItem in the list.

function IndexOf(aItem: TRORequestParam): integer

Parameters:

  • aItem: item whose index will be returned.

Insert

function Insert(aIndex: integer): TRORequestParam

Parameters:

  • aIndex:

Items

This indexer property gives access to the individual parameters contained in the collection.

property Items[Index: integer]: TRORequestParam read write

ParamByName

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

Refresh

procedure Refresh

ResultParam

Returns the parameter from the collection that is marked as fResult. Any request may only contain zero or one parameter marked as result - any other parameters returned from the server must use the fOut flag instead. If no result parameter is found, this property returns nil.

property ResultParam: TRORequestParam read write

 

HasResultParam

Returns whether the collection contains a parameter marked as fResult. Any request may only contain zero or one parameter marked as result - any other parameters returned from the server must use the fOut flag, instead.

property HasResultParam: boolean read write

Items

This indexer property gives access to the individual parameters contained in the collection.

property Items[Index: integer]: TRORequestParam read write

ResultParam

Returns the parameter from the collection that is marked as fResult. Any request may only contain zero or one parameter marked as result - any other parameters returned from the server must use the fOut flag instead. If no result parameter is found, this property returns nil.

property ResultParam: TRORequestParam read write

 

constructor Create

Creates a new instance.

constructor Create(aDynamicRequest: TRODynamicRequest)

Parameters:

  • aDynamicRequest:

Add  overload

function Add: TRORequestParam

Add (string, TRODataType, TRODLParamFlag, string): TRORequestParam  overload

function Add(const aName: string; aDataType: TRODataType; aParamFlag: TRODLParamFlag; const aTypeName: string): TRORequestParam

Parameters:

  • aName:
  • aDataType:
  • aParamFlag:
  • aTypeName:

ClearInputValues

procedure ClearInputValues

ClearOutputValues

procedure ClearOutputValues

ClearValues

procedure ClearValues

Clone

procedure Clone(Source: TRORequestParamCollection)

Parameters:

  • Source:

CopyRODLOperation

procedure CopyRODLOperation(anOperation: TRODLOperation)

Parameters:

  • anOperation:

FindParam

Locates the TRORequestParam with a given name.

function FindParam(const aParamName: string): TRORequestParam

Parameters:

  • aParamName: Name of the parameter

IndexOf

Returns the position of a aItem in the list.

function IndexOf(aItem: TRORequestParam): integer

Parameters:

  • aItem: item whose index will be returned.

Insert

function Insert(aIndex: integer): TRORequestParam

Parameters:

  • aIndex:

ParamByName

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

Refresh

procedure Refresh

See Also