DataParameter

Overview

Stores a name/value pair.

The DataParameter class is used in several IDataAbstractService methods to pass parameters to remote commands and data tables before their execution.

Location

 

constructor

Creates a new DataParameter instance.

 

constructor

 

DataParameter()

constructor (String, VariantType)

Creates a new DataParameter instance with the specified parameter name and value, where value is an instance of the VariantType.

 

constructor(aName: String; aValue: VariantType)

 

DataParameter(String aName, VariantType aValue)

Parameters:

  • aName: The name of the parameter.
  • aValue: The type of parameter's value.

constructor (String, Object)

Creates a new DataParameter instance with the specified parameter name and value.

 

constructor(aName: String; aValue: Object)

 

DataParameter(String aName, Object aValue)

Parameters:

  • aName: The name of the parameter.
  • aValue: The value of the parameter.

getAttributeValue    (declared in ComplexType)

Returns attribute.

 

method getAttributeValue(aName: String): String

 

String getAttributeValue(String aName)

Parameters:

  • aName: Given name.

Name

 

property Name: String read write;

 

String Name { __get; __set; }

readFromMessage (String, Message)

Initializes the current instance from the given message.

 

method readFromMessage(aName: String; aMessage: Message)

 

void readFromMessage(String aName, Message aMessage)

Parameters:

  • aName: The name of the object to get from the message.
  • aMessage: The message to be used in initialization.

readFromMessage (String, Message)    (declared in ComplexType)

For internal use, used by the RO/J framework to stream the Struct to a message packet.

 

method readFromMessage(aName: String; aMessage: Message)

 

void readFromMessage(String aName, Message aMessage)

Parameters:

  • aName: Given name.
  • aMessage: Given message.

setDefaultValues

Not used.

 

class method setDefaultValues(aName: String; aValue: VariantType)

 

static void setDefaultValues(String aName, VariantType aValue)

Parameters:

  • aName:
  • aValue:

Value

 

property Value: VariantType read write;

 

VariantType Value { __get; __set; }

writeToMessage (String, Message)

Serializes instance content using the given message.

 

method writeToMessage(aName: String; aMessage: Message)

 

void writeToMessage(String aName, Message aMessage)

Parameters:

  • aName: The name that should be used to store the instance in the message.
  • aMessage: The message to write the data of the class instance.

writeToMessage (String, Message)    (declared in ComplexType)

For internal use, used by the RO/J framework to stream the Struct to a message packet.

 

method writeToMessage(aName: String; aMessage: Message)

 

void writeToMessage(String aName, Message aMessage)

Parameters:

  • aName: Given name.
  • aMessage: Given message.

 

Name

 

property Name: String read write;

 

String Name { __get; __set; }

Value

 

property Value: VariantType read write;

 

VariantType Value { __get; __set; }

 

setDefaultValues

Not used.

 

class method setDefaultValues(aName: String; aValue: VariantType)

 

static void setDefaultValues(String aName, VariantType aValue)

Parameters:

  • aName:
  • aValue:

 

constructor

Creates a new DataParameter instance.

 

constructor

 

DataParameter()

constructor (String, VariantType)

Creates a new DataParameter instance with the specified parameter name and value, where value is an instance of the VariantType.

 

constructor(aName: String; aValue: VariantType)

 

DataParameter(String aName, VariantType aValue)

Parameters:

  • aName: The name of the parameter.
  • aValue: The type of parameter's value.

constructor (String, Object)

Creates a new DataParameter instance with the specified parameter name and value.

 

constructor(aName: String; aValue: Object)

 

DataParameter(String aName, Object aValue)

Parameters:

  • aName: The name of the parameter.
  • aValue: The value of the parameter.

getAttributeValue    (declared in ComplexType)

Returns attribute.

 

method getAttributeValue(aName: String): String

 

String getAttributeValue(String aName)

Parameters:

  • aName: Given name.

readFromMessage (String, Message)

Initializes the current instance from the given message.

 

method readFromMessage(aName: String; aMessage: Message)

 

void readFromMessage(String aName, Message aMessage)

Parameters:

  • aName: The name of the object to get from the message.
  • aMessage: The message to be used in initialization.

readFromMessage (String, Message)    (declared in ComplexType)

For internal use, used by the RO/J framework to stream the Struct to a message packet.

 

method readFromMessage(aName: String; aMessage: Message)

 

void readFromMessage(String aName, Message aMessage)

Parameters:

  • aName: Given name.
  • aMessage: Given message.

writeToMessage (String, Message)

Serializes instance content using the given message.

 

method writeToMessage(aName: String; aMessage: Message)

 

void writeToMessage(String aName, Message aMessage)

Parameters:

  • aName: The name that should be used to store the instance in the message.
  • aMessage: The message to write the data of the class instance.

writeToMessage (String, Message)    (declared in ComplexType)

For internal use, used by the RO/J framework to stream the Struct to a message packet.

 

method writeToMessage(aName: String; aMessage: Message)

 

void writeToMessage(String aName, Message aMessage)

Parameters:

  • aName: Given name.
  • aMessage: Given message.