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 usually created on the client side and then passed into certain overloads of the DataAdapter.Fill method. Further TableRequestInfo will be serialized into GetData request that will be sent to the server.

Location

 

assignFrom:

Configures instance of the TableRequestInfo class according to given source

- (void) assignFrom:(ROComplexType *)aSource

Parameters:

  • aSource:

deepCopyWithZone:  deprecated    (declared in ROComplexType)

- (id) deepCopyWithZone:(NSZone *)zone

Parameters:

  • zone:

getAttributeValue:    (declared in ROComplexType)

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

Parameters:

  • aName:

IncludeSchema  assign

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 TableRequestInfo

- (id) init

MaxRecords  assign

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

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

@property (retain) DataParameterArray *Parameters

readFromMessage:withName:

Metod deserializes TableRequestInfo with given name from given message

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

Parameters:

  • aMessage:
  • aName:

UserFilter  retain

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

writeToMessage:withName:

Metod serializes TableRequestInfo with given name into given message.

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

Parameters:

  • aMessage:
  • aName:

 

IncludeSchema  assign

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

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

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

@property (retain) DataParameterArray *Parameters

UserFilter  retain

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

 

getAttributeValue:    (declared in ROComplexType)

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

Parameters:

  • aName:

 

assignFrom:

Configures instance of the TableRequestInfo 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 TableRequestInfo

- (id) init

readFromMessage:withName:

Metod deserializes TableRequestInfo with given name from given message

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

Parameters:

  • aMessage:
  • aName:

writeToMessage:withName:

Metod serializes TableRequestInfo with given name into given message.

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

Parameters:

  • aMessage:
  • aName:

Descendants

See Also