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.

Location

 

assignFrom:

Configures instance of the TableRequestInfoV5 class according to given source

- (void) assignFrom:(ROComplexType *)aSource

Parameters:

  • aSource:

deepCopyWithZone:  deprecated    (declared in ROComplexType)

- (id) deepCopyWithZone:(NSZone *)zone

Parameters:

  • zone:

DynamicSelectFieldNames  retain

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

@property (retain) StringArray *DynamicSelectFieldNames

getAttributeValue:    (declared in ROComplexType)

+ (NSString *) getAttributeValue:(NSString *)aName

Parameters:

  • aName:

IncludeSchema  assign    (declared in TableRequestInfo)

Boolean property that specifies if table schema info s needed inside the result stream (true) or not (false, default). Usually, the client side already knows the schema, so passing the schema with the table data will cause some overhead, but if you need to update table schema info on the client side, you need to set that property to true.

@property (assign) BOOL IncludeSchema

init

Initializes instance of the TableRequestInfoV5

- (id) init

MaxRecords  assign    (declared in TableRequestInfo)

This property allows to limit the count of rows of the request. Put it as -1 to receive all available records. 0 value will update the table schema without receiving any data.

Limiting the amount of transferred rows can reduce traffic between the DataAbstract server (middle tier) and the DataAbstract client (front-end tier). It will not affect traffic between the database and the DataAbstract server. For reducing traffic between the database and the DataAbstract server, you have to use other approaches, like Dynamic Where.

@property (assign) int32 MaxRecords

Parameters  retain    (declared in TableRequestInfo)

Represents the array of the DataParameters for getting data from parametrized schema tables.

@property (retain) DataParameterArray *Parameters

readFromMessage:withName:

Metod deserializes TableRequestInfoV5 with given name from given message

- (void) readFromMessage:(ROMessage *)aMessage withName:(NSString *)aName

Parameters:

  • aMessage:
  • aName:

Sorting  retain

Property represents the information about sorting result data.

@property (retain) ColumnSorting *Sorting

UserFilter  retain    (declared in TableRequestInfo)

Uses for specifying custom conditions for returning rows. For example, "CustomerType < 100". Note that all records will be read from the database, but only those that fit the custom condition will be passed to the client.

@property (retain) NSString *UserFilter

WhereClause  retain

Property that holds Dynamic Where expression in XML format.

@property (retain) ROXml *WhereClause

writeToMessage:withName:

Metod serializes TableRequestInfoV5 with given name into given message.

- (void) writeToMessage:(ROMessage *)aMessage withName:(NSString *)aName

Parameters:

  • aMessage:
  • aName:

 

DynamicSelectFieldNames  retain

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

@property (retain) StringArray *DynamicSelectFieldNames

IncludeSchema  assign    (declared in TableRequestInfo)

Boolean property that specifies if table schema info s needed inside the result stream (true) or not (false, default). Usually, the client side already knows the schema, so passing the schema with the table data will cause some overhead, but if you need to update table schema info on the client side, you need to set that property to true.

@property (assign) BOOL IncludeSchema

MaxRecords  assign    (declared in TableRequestInfo)

This property allows to limit the count of rows of the request. Put it as -1 to receive all available records. 0 value will update the table schema without receiving any data.

Limiting the amount of transferred rows can reduce traffic between the DataAbstract server (middle tier) and the DataAbstract client (front-end tier). It will not affect traffic between the database and the DataAbstract server. For reducing traffic between the database and the DataAbstract server, you have to use other approaches, like Dynamic Where.

@property (assign) int32 MaxRecords

Parameters  retain    (declared in TableRequestInfo)

Represents the array of the DataParameters for getting data from parametrized schema tables.

@property (retain) DataParameterArray *Parameters

Sorting  retain

Property represents the information about sorting result data.

@property (retain) ColumnSorting *Sorting

UserFilter  retain    (declared in TableRequestInfo)

Uses for specifying custom conditions for returning rows. For example, "CustomerType < 100". Note that all records will be read from the database, but only those that fit the custom condition will be passed to the client.

@property (retain) NSString *UserFilter

WhereClause  retain

Property that holds Dynamic Where expression in XML format.

@property (retain) ROXml *WhereClause

 

getAttributeValue:    (declared in ROComplexType)

+ (NSString *) getAttributeValue:(NSString *)aName

Parameters:

  • aName:

 

assignFrom:

Configures instance of the TableRequestInfoV5 class according to given source

- (void) assignFrom:(ROComplexType *)aSource

Parameters:

  • aSource:

deepCopyWithZone:  deprecated    (declared in ROComplexType)

- (id) deepCopyWithZone:(NSZone *)zone

Parameters:

  • zone:

init

Initializes instance of the TableRequestInfoV5

- (id) init

readFromMessage:withName:

Metod deserializes TableRequestInfoV5 with given name from given message

- (void) readFromMessage:(ROMessage *)aMessage withName:(NSString *)aName

Parameters:

  • aMessage:
  • aName:

writeToMessage:withName:

Metod serializes TableRequestInfoV5 with given name into given message.

- (void) writeToMessage:(ROMessage *)aMessage withName:(NSString *)aName

Parameters:

  • aMessage:
  • aName:

See Also