SimpleRequestInfo

Overview

SimpleRequestInfo is used for requests to a DataAbstract server with the SimpleGetData call as an alternative to the GetData call. The simple version is callable from xml-rpc and json servers and doesn't require specialized serializers.

Location

 

assignFrom:

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

When returning the data, include the field information.

@property (assign) BOOL IncludeSchema

init

Initializes new instance of the SimpleRequestInfo

- (id) init

MaxRecords  assign

Maximum number of records to return. <1 is infinite.

@property (assign) int32 MaxRecords

Parameters  retain

List of parameters for this request.

@property (retain) SimpleDataParameterArray *Parameters

readFromMessage:withName:

Metod deserializes SimpleRequestInfo with given name from given message

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

Parameters:

  • aMessage:
  • aName:

SimpleMode  assign

If this is true, the response won't use the SimpleDataResult classes but will be a structure with field names matching the table field names.

@property (assign) BOOL SimpleMode

SQL  retain

SQL query to execute. When this is set the table name is ignored, the string here is passed to the DASQL processor, not directly to the server.

@property (retain) NSString *SQL

Table  retain

Table to request.

@property (retain) NSString *Table

Where  retain

Where condition to use. This should be formatted along the lines of sql where expressions.

@property (retain) NSString *Where

writeToMessage:withName:

Metod serializes SimpleRequestInfo with given name into given message.

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

Parameters:

  • aMessage:
  • aName:

 

IncludeSchema  assign

When returning the data, include the field information.

@property (assign) BOOL IncludeSchema

MaxRecords  assign

Maximum number of records to return. <1 is infinite.

@property (assign) int32 MaxRecords

Parameters  retain

List of parameters for this request.

@property (retain) SimpleDataParameterArray *Parameters

SimpleMode  assign

If this is true, the response won't use the SimpleDataResult classes but will be a structure with field names matching the table field names.

@property (assign) BOOL SimpleMode

SQL  retain

SQL query to execute. When this is set the table name is ignored, the string here is passed to the DASQL processor, not directly to the server.

@property (retain) NSString *SQL

Table  retain

Table to request.

@property (retain) NSString *Table

Where  retain

Where condition to use. This should be formatted along the lines of sql where expressions.

@property (retain) NSString *Where

 

getAttributeValue:    (declared in ROComplexType)

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

Parameters:

  • aName:

 

assignFrom:

Configures instance of the SimpleRequestInfo class according to given source

- (void) assignFrom:(ROComplexType *)aSource

Parameters:

  • aSource:

deepCopyWithZone:  deprecated    (declared in ROComplexType)

- (id) deepCopyWithZone:(NSZone *)zone

Parameters:

  • zone:

init

Initializes new instance of the SimpleRequestInfo

- (id) init

readFromMessage:withName:

Metod deserializes SimpleRequestInfo with given name from given message

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

Parameters:

  • aMessage:
  • aName:

writeToMessage:withName:

Metod serializes SimpleRequestInfo with given name into given message.

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

Parameters:

  • aMessage:
  • aName:

See Also