TableRequestInfoV6

Overview

As well as TableRequestInfoV5, TableRequestInfoV6 class allows to specify additional custom parameters for getting data from certain schema table.

TableRequestInfoV6 extends TableRequestInfo class with the new DA SQL feature that is supported starting from DA v5. It allows to pass DA SQL statement that need to be executed on the server.

For example

 

TableRequestInfo request = new TableRequestInfoV6();
request.setSql("SELECT id, name FROM mySchemaTable WHERE name LIKE 'A%' ORDER BY id DESC");
request.setMaxRecords(-1);
request.setIncludeSchema(true);
remoteAdapter.fill("MyTable", request, true);

 

var request := new TableRequestInfoV6(
  Sql := 'SELECT id, name FROM mySchemaTable WHERE name LIKE `A%` ORDER BY id DESC');
request.MaxRecords := -1;
request.IncludeSchema := True;

var lTable := new DataTable('MyTable');

remoteAdapter.fill(lTable, request);

In practice, you don't need to deal with TableRequestInfoV6 directly. as RemoteDataAdapters has handy fillWithSql method that allows to specify only DA SQL expression; proper request info object will be created behind the scene.

Location

 

constructor

Creates a new TableRequestInfoV6 instance.

 

constructor

 

TableRequestInfoV6()

constructor (Integer)    (declared in TableRequestInfo)

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

 

constructor(aMaxRecords: Integer)

 

TableRequestInfoV6(Integer aMaxRecords)

Parameters:

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

constructor (Integer, DataParameter[])

 

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

 

TableRequestInfoV6(Integer aMaxRecords, DataParameter[] aParameters)

Parameters:

  • aMaxRecords:
  • aParameters:

constructor (Integer, Boolean)    (declared in TableRequestInfo)

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

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean)

 

TableRequestInfoV6(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[])

 

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

 

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

Parameters:

  • aMaxRecords:
  • aIncludeSchema:
  • aParameters:

constructor (Integer, Boolean, DataParameterArray)    (declared in TableRequestInfo) obsolete

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

 

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

 

TableRequestInfoV6(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)    (declared in TableRequestInfo)

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

 

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

 

TableRequestInfoV6(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[])

 

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

 

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

Parameters:

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

constructor (Integer, Boolean, String, DataParameterArray)    (declared in TableRequestInfo) obsolete

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

 

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

 

TableRequestInfoV6(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)    (declared in TableRequestInfo) obsolete

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

 

constructor(aMaxRecords: Integer; aParameters: DataParameterArray)

 

TableRequestInfoV6(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    (declared in TableRequestInfo)

 

property IncludeSchema: Boolean read write;

 

Boolean IncludeSchema { __get; __set; }

MaxRecords    (declared in TableRequestInfo)

 

property MaxRecords: Integer read write;

 

Integer MaxRecords { __get; __set; }

Parameters    (declared in TableRequestInfo)

 

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 (String)

Not used.

 

class method setDefaultValues(aSql: String)

 

static void setDefaultValues(String aSql)

Parameters:

  • aSql:

setDefaultValues (String, Boolean, Integer, DataParameterArray)    (declared in TableRequestInfo)

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:

Sql

 

property Sql: String read write;

 

String Sql { __get; __set; }

UserFilter    (declared in TableRequestInfo)

 

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    (declared in TableRequestInfo)

 

property IncludeSchema: Boolean read write;

 

Boolean IncludeSchema { __get; __set; }

MaxRecords    (declared in TableRequestInfo)

 

property MaxRecords: Integer read write;

 

Integer MaxRecords { __get; __set; }

Parameters    (declared in TableRequestInfo)

 

property Parameters: DataParameterArray read write;

 

DataParameterArray Parameters { __get; __set; }

Sql

 

property Sql: String read write;

 

String Sql { __get; __set; }

UserFilter    (declared in TableRequestInfo)

 

property UserFilter: String read write;

 

String UserFilter { __get; __set; }

 

setDefaultValues (String)

Not used.

 

class method setDefaultValues(aSql: String)

 

static void setDefaultValues(String aSql)

Parameters:

  • aSql:

setDefaultValues (String, Boolean, Integer, DataParameterArray)    (declared in TableRequestInfo)

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

Creates a new TableRequestInfoV6 instance.

 

constructor

 

TableRequestInfoV6()

constructor (Integer)    (declared in TableRequestInfo)

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

 

constructor(aMaxRecords: Integer)

 

TableRequestInfoV6(Integer aMaxRecords)

Parameters:

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

constructor (Integer, DataParameter[])

 

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

 

TableRequestInfoV6(Integer aMaxRecords, DataParameter[] aParameters)

Parameters:

  • aMaxRecords:
  • aParameters:

constructor (Integer, Boolean)    (declared in TableRequestInfo)

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

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean)

 

TableRequestInfoV6(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[])

 

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

 

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

Parameters:

  • aMaxRecords:
  • aIncludeSchema:
  • aParameters:

constructor (Integer, Boolean, DataParameterArray)    (declared in TableRequestInfo) obsolete

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

 

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

 

TableRequestInfoV6(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)    (declared in TableRequestInfo)

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

 

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

 

TableRequestInfoV6(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[])

 

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

 

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

Parameters:

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

constructor (Integer, Boolean, String, DataParameterArray)    (declared in TableRequestInfo) obsolete

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

 

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

 

TableRequestInfoV6(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)    (declared in TableRequestInfo) obsolete

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

 

constructor(aMaxRecords: Integer; aParameters: DataParameterArray)

 

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

See Also

RemoteDataAdapter * TableRequestInfoV5 * TableRequestInfoV6