TRODLOperationParam

Overview

The TRODLOperationParam class represents method parameters in RODL.

Use Case

The TRODLOperationParam class is used internally for auto code generation and for conversion from RODL into different formats (such as WSDL for SOAP clients). You may use this class to access service methods parameters (for more information please refer to the Manipulation of RODL Meta Data article).

Location

 

constructor Create  virtual    (declared in TRODLEntity)

Creates a new instance with a unique GUID.

constructor Create

Assign  override

Copies data from a given source.

procedure Assign(const Source: TRODLEntity)

Parameters:

  • Source: Instance whose properties will be copied

Attributes    (declared in TRODLEntity)

List of strings that represents object attributes.

property Attributes: TStrings read

Data    (declared in TRODLEntity)

Object associated with the current TRODLEntity object. This property is needed to hold custom application-specific data at runtime for application coding convenience.

property Data: TObject read write

DataType    (declared in TRODLTypedEntity)

This property represents the type of entity. It can be a common type like Integer or Boolean or one of your custom types, which are defined in RODL.

property DataType: string read write

Documentation    (declared in TRODLEntity)

Description of the current object.

property Documentation: UnicodeString read write

DontCodegen    (declared in TRODLEntity)

property DontCodegen: Boolean read write

Flag

This property represents an indication for parameter type, possible values include the following:

  • fIn - Input only parameter.
  • fOut - Output only parameter.
  • fInOut - Variable parameter.
  • fResult - Parameter is holds the function's return value.
property Flag: TRODLParamFlag read write

FlagAsString

property FlagAsString: string read write

GetDontCodegen  protected virtual    (declared in TRODLEntity)

function GetDontCodegen: Boolean

GroupUnder    (declared in TRODLEntity)

If the object is contained in group, this property returns the group object, otherwise it returns nil.

property GroupUnder: TRODLGroup read write

Info    (declared in TRODLEntity)

The TRODLEntity object that is associated with the current object. It is needed for backwards compatibility.

property Info: TRODLEntity read

InUse    (declared in TRODLEntity)

property InUse: TRODLUseList read

InUseCount    (declared in TRODLEntity)

property InUseCount: Integer read

IsFromUsedRodl    (declared in TRODLEntity)

Indicates when a class refers to the linked RODL file. The linked RODL file is declared in the section Uses of the current RODL file.

property IsFromUsedRodl: Boolean read

LocatedInRodlUse    (declared in TRODLEntity)

Detailed info about the RODL that is using the current TRODLEntity object.

property LocatedInRodlUse: TRODLUse read write

Name    (declared in TRODLEntity)

The Name of the current TRODLEntity object.

property Name: string read write

OriginalName    (declared in TRODLEntity)

The OriginalName of the current TRODLEntity object. If the private variable fOriginalName is not defined, OriginalName equals Name.

property OriginalName: string read write

Owner    (declared in TRODLEntity)

The Owner of the current TRODLEntity object.

property Owner: TRODLEntity read

OwnerLibrary    (declared in TRODLEntity)

The owner library of the current object.

property OwnerLibrary: TRODLLibrary read

ReadableEntityTypeName    (declared in TRODLEntity)

Returns the class name without the prefix 'TRODL'.

class function ReadableEntityTypeName: string

UID    (declared in TRODLEntity)

Unique identifier.

property UID: TGUID read write

Validate  override    (declared in TRODLTypedEntity)

Validates the current object.

procedure Validate(aMessages: IROPluginMessages)

Parameters:

  • aMessages: plugin

 

Attributes    (declared in TRODLEntity)

List of strings that represents object attributes.

property Attributes: TStrings read

Data    (declared in TRODLEntity)

Object associated with the current TRODLEntity object. This property is needed to hold custom application-specific data at runtime for application coding convenience.

property Data: TObject read write

DataType    (declared in TRODLTypedEntity)

This property represents the type of entity. It can be a common type like Integer or Boolean or one of your custom types, which are defined in RODL.

property DataType: string read write

Documentation    (declared in TRODLEntity)

Description of the current object.

property Documentation: UnicodeString read write

DontCodegen    (declared in TRODLEntity)

property DontCodegen: Boolean read write

Flag

This property represents an indication for parameter type, possible values include the following:

  • fIn - Input only parameter.
  • fOut - Output only parameter.
  • fInOut - Variable parameter.
  • fResult - Parameter is holds the function's return value.
property Flag: TRODLParamFlag read write

FlagAsString

property FlagAsString: string read write

GroupUnder    (declared in TRODLEntity)

If the object is contained in group, this property returns the group object, otherwise it returns nil.

property GroupUnder: TRODLGroup read write

Info    (declared in TRODLEntity)

The TRODLEntity object that is associated with the current object. It is needed for backwards compatibility.

property Info: TRODLEntity read

InUse    (declared in TRODLEntity)

property InUse: TRODLUseList read

InUseCount    (declared in TRODLEntity)

property InUseCount: Integer read

IsFromUsedRodl    (declared in TRODLEntity)

Indicates when a class refers to the linked RODL file. The linked RODL file is declared in the section Uses of the current RODL file.

property IsFromUsedRodl: Boolean read

LocatedInRodlUse    (declared in TRODLEntity)

Detailed info about the RODL that is using the current TRODLEntity object.

property LocatedInRodlUse: TRODLUse read write

Name    (declared in TRODLEntity)

The Name of the current TRODLEntity object.

property Name: string read write

OriginalName    (declared in TRODLEntity)

The OriginalName of the current TRODLEntity object. If the private variable fOriginalName is not defined, OriginalName equals Name.

property OriginalName: string read write

Owner    (declared in TRODLEntity)

The Owner of the current TRODLEntity object.

property Owner: TRODLEntity read

OwnerLibrary    (declared in TRODLEntity)

The owner library of the current object.

property OwnerLibrary: TRODLLibrary read

UID    (declared in TRODLEntity)

Unique identifier.

property UID: TGUID read write

 

ReadableEntityTypeName    (declared in TRODLEntity)

Returns the class name without the prefix 'TRODL'.

class function ReadableEntityTypeName: string

 

constructor Create  virtual    (declared in TRODLEntity)

Creates a new instance with a unique GUID.

constructor Create

Assign  override

Copies data from a given source.

procedure Assign(const Source: TRODLEntity)

Parameters:

  • Source: Instance whose properties will be copied

GetDontCodegen  protected virtual    (declared in TRODLEntity)

function GetDontCodegen: Boolean

Validate  override    (declared in TRODLTypedEntity)

Validates the current object.

procedure Validate(aMessages: IROPluginMessages)

Parameters:

  • aMessages: plugin