TableRequestInfo

Overview

TableRequestInfo allows you to specify additional parameters for querying certain schema tables.

With TableRequestInfo you can: *specify custom parameters for getting data from parametrized schema tables. *specify if schema information is received inside the encoded schema table data. *specify the count of records you want to obtain.

Instances of the TableRequestInfo class are created on the client side and then passed into certain overloads of the DataAdapter.Fill method. Then TableRequestInfo will be serialized into GetData request that will be sent to the server.

You will quite often need to create and configure instances of the TableRequestInfo class to perform specific Fill requests. To make it easier, the class provides several constructors to initialize additional parameters.

The sample code below demonstrates how to obtain data from a parametrized schema table:

String lCustomerID = "ALFKI";
TableRequestInfo reqInfo = new TableRequestInfo(
              "",    // User custom filter
              -1,    // Max records count (-1 means unlimited count)
              false, // Include schema or not
              new DataParameterArray(
                    new String[] { "pCustomerID" }, // array of the parameter names
                    new Object[] { lCustomerID }    // array of the parameter values
              )
            );
DataTable orders = new DataTable("Orders");
remoteDataAdapter.fill(orders, reqInfo);

Location

 

constructor

Empty constructor that creates and instance of an object.

 

constructor

 

TableRequestInfo()

constructor (Integer)

Creates an instance of an object with the specified maxRecords value.

 

constructor(aMaxRecords: Integer)

 

TableRequestInfo(Integer aMaxRecords)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.

constructor (Integer, DataParameter[])

Creates an instance of an object with the specified maxRecords and the array of data parameters.

 

constructor(aMaxRecords: Integer; aParameters: array of DataParameter)

 

TableRequestInfo(Integer aMaxRecords, DataParameter[] aParameters)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aParameters: A data parameters to use with parameterized tables.

constructor (Integer, Boolean)

Creates an instance of an object with the specified maxRecords and IncludeSchema value.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.

constructor (Integer, Boolean, DataParameter[])

Creates an instance of an object with the specified maxRecords IncludeSchema and the array of data parameters.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean; aParameters: array of DataParameter)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema, DataParameter[] aParameters)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.
  • aParameters: A data parameters to use with parameterized tables.

constructor (Integer, Boolean, DataParameterArray) obsolete

Creates an instance of an object and initializes maxRecords, includeSchema and parameters properties.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean; aParameters: DataParameterArray)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema, DataParameterArray aParameters)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.
  • aParameters: A data parameters to use with parameterized tables.

constructor (Integer, Boolean, String)

Creates an instance of an object with the specified maxRecords, IncludeSchema and UserFilter values.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean; aUserFilter: String)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema, String aUserFilter)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.
  • aUserFilter: The string with additional filter conditions.

constructor (Integer, Boolean, String, DataParameter[])

Creates an instance of an object with the specified maxRecords IncludeSchema, UserFilter and the array of data parameters.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean; aUserFilter: String; aParameters: array of DataParameter)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema, String aUserFilter, DataParameter[] aParameters)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.
  • aUserFilter: The string with additional filter conditions.
  • aParameters: A data parameters to use with parameterized tables.

constructor (Integer, Boolean, String, DataParameterArray) obsolete

Creates an instance of an object and initializes maxRecords, includeSchema, userFilter and parameters properties.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean; aUserFilter: String; aParameters: DataParameterArray)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema, String aUserFilter, DataParameterArray aParameters)

Parameters:

  • aMaxRecords: A maximum number of data records to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.
  • aUserFilter: The string with additional filter conditions.
  • aParameters: A data parameters to use with parameterized tables.

constructor (Integer, DataParameterArray) obsolete

Creates an instance of an object and initializes maxRecords and parameters properties.

 

constructor(aMaxRecords: Integer; aParameters: DataParameterArray)

 

TableRequestInfo(Integer aMaxRecords, DataParameterArray aParameters)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aParameters: A data parameters to use with parameterized tables.

getAttributeValue    (declared in ComplexType)

Returns attribute.

 

method getAttributeValue(aName: String): String

 

String getAttributeValue(String aName)

Parameters:

  • aName: Given name.

IncludeSchema

 

property IncludeSchema: Boolean read write;

 

Boolean IncludeSchema { __get; __set; }

MaxRecords

 

property MaxRecords: Integer read write;

 

Integer MaxRecords { __get; __set; }

Parameters

 

property Parameters: DataParameterArray read write;

 

DataParameterArray Parameters { __get; __set; }

readFromMessage    (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(aUserFilter: String; aIncludeSchema: Boolean; aMaxRecords: Integer; aParameters: DataParameterArray)

 

static void setDefaultValues(String aUserFilter, Boolean aIncludeSchema, Integer aMaxRecords, DataParameterArray aParameters)

Parameters:

  • aUserFilter:
  • aIncludeSchema:
  • aMaxRecords:
  • aParameters:

UserFilter

 

property UserFilter: String read write;

 

String UserFilter { __get; __set; }

writeToMessage    (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.

 

IncludeSchema

 

property IncludeSchema: Boolean read write;

 

Boolean IncludeSchema { __get; __set; }

MaxRecords

 

property MaxRecords: Integer read write;

 

Integer MaxRecords { __get; __set; }

Parameters

 

property Parameters: DataParameterArray read write;

 

DataParameterArray Parameters { __get; __set; }

UserFilter

 

property UserFilter: String read write;

 

String UserFilter { __get; __set; }

 

setDefaultValues

Not used.

 

class method setDefaultValues(aUserFilter: String; aIncludeSchema: Boolean; aMaxRecords: Integer; aParameters: DataParameterArray)

 

static void setDefaultValues(String aUserFilter, Boolean aIncludeSchema, Integer aMaxRecords, DataParameterArray aParameters)

Parameters:

  • aUserFilter:
  • aIncludeSchema:
  • aMaxRecords:
  • aParameters:

 

constructor

Empty constructor that creates and instance of an object.

 

constructor

 

TableRequestInfo()

constructor (Integer)

Creates an instance of an object with the specified maxRecords value.

 

constructor(aMaxRecords: Integer)

 

TableRequestInfo(Integer aMaxRecords)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.

constructor (Integer, DataParameter[])

Creates an instance of an object with the specified maxRecords and the array of data parameters.

 

constructor(aMaxRecords: Integer; aParameters: array of DataParameter)

 

TableRequestInfo(Integer aMaxRecords, DataParameter[] aParameters)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aParameters: A data parameters to use with parameterized tables.

constructor (Integer, Boolean)

Creates an instance of an object with the specified maxRecords and IncludeSchema value.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.

constructor (Integer, Boolean, DataParameter[])

Creates an instance of an object with the specified maxRecords IncludeSchema and the array of data parameters.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean; aParameters: array of DataParameter)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema, DataParameter[] aParameters)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.
  • aParameters: A data parameters to use with parameterized tables.

constructor (Integer, Boolean, DataParameterArray) obsolete

Creates an instance of an object and initializes maxRecords, includeSchema and parameters properties.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean; aParameters: DataParameterArray)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema, DataParameterArray aParameters)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.
  • aParameters: A data parameters to use with parameterized tables.

constructor (Integer, Boolean, String)

Creates an instance of an object with the specified maxRecords, IncludeSchema and UserFilter values.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean; aUserFilter: String)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema, String aUserFilter)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.
  • aUserFilter: The string with additional filter conditions.

constructor (Integer, Boolean, String, DataParameter[])

Creates an instance of an object with the specified maxRecords IncludeSchema, UserFilter and the array of data parameters.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean; aUserFilter: String; aParameters: array of DataParameter)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema, String aUserFilter, DataParameter[] aParameters)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.
  • aUserFilter: The string with additional filter conditions.
  • aParameters: A data parameters to use with parameterized tables.

constructor (Integer, Boolean, String, DataParameterArray) obsolete

Creates an instance of an object and initializes maxRecords, includeSchema, userFilter and parameters properties.

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean; aUserFilter: String; aParameters: DataParameterArray)

 

TableRequestInfo(Integer aMaxRecords, Boolean aIncludeSchema, String aUserFilter, DataParameterArray aParameters)

Parameters:

  • aMaxRecords: A maximum number of data records to be retrieved.
  • aIncludeSchema: The flag defines, if a Schema should be included in the server response.
  • aUserFilter: The string with additional filter conditions.
  • aParameters: A data parameters to use with parameterized tables.

constructor (Integer, DataParameterArray) obsolete

Creates an instance of an object and initializes maxRecords and parameters properties.

 

constructor(aMaxRecords: Integer; aParameters: DataParameterArray)

 

TableRequestInfo(Integer aMaxRecords, DataParameterArray aParameters)

Parameters:

  • aMaxRecords: A maximum number of data ecords to be retrieved.
  • aParameters: A data parameters to use with parameterized tables.

getAttributeValue    (declared in ComplexType)

Returns attribute.

 

method getAttributeValue(aName: String): String

 

String getAttributeValue(String aName)

Parameters:

  • aName: Given name.

readFromMessage    (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    (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.

Descendants

See Also

RemoteDataAdapter * TableRequestInfoV5 * TableRequestInfoV6