TableRequestInfoV5

Overview

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

TableRequestInfoV5 extends TableRequestInfo class with new features Dynamic Where and Dynamic Select supported starting from DA v5.

Below you can find a sample that shows how to create and use TableRequestInfoV5.

 

// prepare dynamic where
Node dynWhere = null;
dynWhere =
new BinaryExpression(
  new FieldExpression("ProductGroup"),
  new ConstantExpression(aGroupId,
    RemObjects.DataAbstract.Schema.DataType.Integer),
  BinaryOperator.Equal).toXmlNode();

// create and setup request info
TableRequestInfoV5 requestInfo = new TableRequestInfoV5();
requestInfo.DynamicSelectFieldNames =
new String[] {
  "ProductId",
  "ProductCode",
  "ProductName",
  "ProductWarranty",
  "IsObsolete",
  "ProductGroup"};

requestInfo.MaxRecords = -1;
requestInfo.WhereClause = dynWhere;

// execute request
remoteDataAdapter.Fill(
pDCTradeDataset,
new String[] { "Products" },
new TableRequestInfo[] { requestInfo });

 

// prepare dynamic where
var dynWhere: WhereExpression;
dynWhere := new BinaryExpression(
                  new FieldExpression("ProductGroup"),
                  new ConstantExpression(aGroupId, RemObjects.DataAbstract.Schema.DataType.Integer),
                  BinaryOperator.Equal).toXmlNode();

// create and setup request info
var requestInfo := new TableRequestInfoV5();
requestInfo.DynamicSelectFieldNames := [
  "ProductId",
  "ProductCode",
  "ProductName",
  "ProductWarranty",
  "IsObsolete",
  "ProductGroup"];

requestInfo.MaxRecords := -1;
requestInfo.WhereClause := dynWhere;

// execute request
remoteDataAdapter.fill("Products", requestInfo);

Location


 

constructor

Creates a new TAbleRequestInfoV5 instance.

 

constructor

 

TableRequestInfoV5()

constructor (Integer)    (declared in TableRequestInfo)

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

 

constructor(aMaxRecords: Integer)

 

TableRequestInfoV5(Integer aMaxRecords)

Parameters:

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

constructor (Integer, Boolean)    (declared in TableRequestInfo)

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

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean)

 

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

 

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

 

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

 

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

 

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

 

TableRequestInfoV5(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, DataParameter[])

 

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

 

TableRequestInfoV5(Integer aMaxRecords, DataParameter[] aParameters)

Parameters:

  • aMaxRecords:
  • aParameters:

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

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

 

constructor(aMaxRecords: Integer; aParameters: DataParameterArray)

 

TableRequestInfoV5(Integer aMaxRecords, DataParameterArray aParameters)

Parameters:

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

DynamicSelectFieldNames

Property that holds an array of field names for Dynamic Select feature.

 

property DynamicSelectFieldNames: StringArray read write;

 

StringArray DynamicSelectFieldNames { __get; __set; }

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, Boolean, Integer, DataParameterArray)    (declared in TableRequestInfo)

Not used.

 

class method setDefaultValues(p_UserFilter: String; p_IncludeSchema: Boolean; p_MaxRecords: Integer; p_Parameters: DataParameterArray)

 

static void setDefaultValues(String p_UserFilter, Boolean p_IncludeSchema, Integer p_MaxRecords, DataParameterArray p_Parameters)

Parameters:

  • p_UserFilter:
  • p_IncludeSchema:
  • p_MaxRecords:
  • p_Parameters:

setDefaultValues (XmlType, StringArray, ColumnSorting)

Not used.

 

class method setDefaultValues(p_WhereClause: XmlType; p_DynamicSelectFieldNames: StringArray; p_Sorting: ColumnSorting)

 

static void setDefaultValues(XmlType p_WhereClause, StringArray p_DynamicSelectFieldNames, ColumnSorting p_Sorting)

Parameters:

  • p_WhereClause:
  • p_DynamicSelectFieldNames:
  • p_Sorting:

Sorting

 

property Sorting: ColumnSorting read write;

 

ColumnSorting Sorting { __get; __set; }

UserFilter    (declared in TableRequestInfo)

 

property UserFilter: String read write;

 

String UserFilter { __get; __set; }

WhereClause

 

property WhereClause: XmlType read write;

 

XmlType WhereClause { __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.

 

DynamicSelectFieldNames

Property that holds an array of field names for Dynamic Select feature.

 

property DynamicSelectFieldNames: StringArray read write;

 

StringArray DynamicSelectFieldNames { __get; __set; }

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; }

Sorting

 

property Sorting: ColumnSorting read write;

 

ColumnSorting Sorting { __get; __set; }

UserFilter    (declared in TableRequestInfo)

 

property UserFilter: String read write;

 

String UserFilter { __get; __set; }

WhereClause

 

property WhereClause: XmlType read write;

 

XmlType WhereClause { __get; __set; }

 

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

Not used.

 

class method setDefaultValues(p_UserFilter: String; p_IncludeSchema: Boolean; p_MaxRecords: Integer; p_Parameters: DataParameterArray)

 

static void setDefaultValues(String p_UserFilter, Boolean p_IncludeSchema, Integer p_MaxRecords, DataParameterArray p_Parameters)

Parameters:

  • p_UserFilter:
  • p_IncludeSchema:
  • p_MaxRecords:
  • p_Parameters:

setDefaultValues (XmlType, StringArray, ColumnSorting)

Not used.

 

class method setDefaultValues(p_WhereClause: XmlType; p_DynamicSelectFieldNames: StringArray; p_Sorting: ColumnSorting)

 

static void setDefaultValues(XmlType p_WhereClause, StringArray p_DynamicSelectFieldNames, ColumnSorting p_Sorting)

Parameters:

  • p_WhereClause:
  • p_DynamicSelectFieldNames:
  • p_Sorting:

 

constructor

Creates a new TAbleRequestInfoV5 instance.

 

constructor

 

TableRequestInfoV5()

constructor (Integer)    (declared in TableRequestInfo)

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

 

constructor(aMaxRecords: Integer)

 

TableRequestInfoV5(Integer aMaxRecords)

Parameters:

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

constructor (Integer, Boolean)    (declared in TableRequestInfo)

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

 

constructor(aMaxRecords: Integer; aIncludeSchema: Boolean)

 

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

 

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

 

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

 

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

 

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

 

TableRequestInfoV5(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, DataParameter[])

 

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

 

TableRequestInfoV5(Integer aMaxRecords, DataParameter[] aParameters)

Parameters:

  • aMaxRecords:
  • aParameters:

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

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

 

constructor(aMaxRecords: Integer; aParameters: DataParameterArray)

 

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