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
- Reference: DataAbstractSimple_Intf.h
- Namespace: DataAbstract
- Ancestry: NSObject | ROComplexType | SimpleRequestInfo
assignFrom: assignFrom:(ROComplexType *)
Configures instance of the SimpleRequestInfo class according to given source
- (void) assignFrom:(ROComplexType *)aValue
Parameters:
- aValue:
assignFrom: assignFrom:(nonnull ROComplexType *) (declared in ROComplexType)
- (void) assignFrom:(nonnull ROComplexType *)source
Parameters:
- source:
deepCopyWithZone: deprecated (declared in ROComplexType)
- (nullable id) deepCopyWithZone:(nullable NSZone *)zone
Parameters:
- zone:
getAttributeValue: (declared in ROComplexType)
+ (nullable NSString *) getAttributeValue:(nonnull NSString *)aName
Parameters:
- aName:
IncludeSchema nonatomic
When returning the data, include the field information.
@property (nonatomic) BOOL IncludeSchema
MaxRecords nonatomic
Maximum number of records to return. <1 is infinite.
@property (nonatomic) int32 MaxRecords
Parameters nonatomic
List of parameters for this request.
@property (nonatomic) SimpleDataParameterArray *Parameters
readFromMessage:withName: readFromMessage:(nonnull ROMessage *) withName:(nullable NSString *) (declared in ROComplexType)
- (void) readFromMessage:(nonnull ROMessage *)aMessage withName:(nullable NSString *)aName
Parameters:
- aMessage:
- aName:
readFromMessage:withName: readFromMessage:(ROMessage *) withName:(NSString *)
Metod deserializes SimpleRequestInfo with given name from given message
- (void) readFromMessage:(ROMessage *)aMessage withName:(NSString *)aName
Parameters:
- aMessage:
- aName:
SimpleMode nonatomic
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 (nonatomic) BOOL SimpleMode
SQL nonatomic
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 (nonatomic) NSString *SQL
Table nonatomic
Table to request.
@property (nonatomic) NSString *Table
Where nonatomic
Where condition to use. This should be formatted along the lines of sql where expressions.
@property (nonatomic) NSString *Where
writeToMessage:withName: writeToMessage:(nonnull ROMessage *) withName:(nullable NSString *) (declared in ROComplexType)
- (void) writeToMessage:(nonnull ROMessage *)aMessage withName:(nullable NSString *)aName
Parameters:
- aMessage:
- aName:
writeToMessage:withName: writeToMessage:(ROMessage *) withName:(NSString *)
Metod serializes SimpleRequestInfo with given name into given message.
- (void) writeToMessage:(ROMessage *)aMessage withName:(NSString *)aName
Parameters:
- aMessage:
- aName:
IncludeSchema nonatomic
When returning the data, include the field information.
@property (nonatomic) BOOL IncludeSchema
MaxRecords nonatomic
Maximum number of records to return. <1 is infinite.
@property (nonatomic) int32 MaxRecords
Parameters nonatomic
List of parameters for this request.
@property (nonatomic) SimpleDataParameterArray *Parameters
SimpleMode nonatomic
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 (nonatomic) BOOL SimpleMode
SQL nonatomic
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 (nonatomic) NSString *SQL
Table nonatomic
Table to request.
@property (nonatomic) NSString *Table
Where nonatomic
Where condition to use. This should be formatted along the lines of sql where expressions.
@property (nonatomic) NSString *Where
getAttributeValue: (declared in ROComplexType)
+ (nullable NSString *) getAttributeValue:(nonnull NSString *)aName
Parameters:
- aName:
assignFrom: assignFrom:(ROComplexType *)
Configures instance of the SimpleRequestInfo class according to given source
- (void) assignFrom:(ROComplexType *)aValue
Parameters:
- aValue:
assignFrom: assignFrom:(nonnull ROComplexType *) (declared in ROComplexType)
- (void) assignFrom:(nonnull ROComplexType *)source
Parameters:
- source:
deepCopyWithZone: deprecated (declared in ROComplexType)
- (nullable id) deepCopyWithZone:(nullable NSZone *)zone
Parameters:
- zone:
readFromMessage:withName: readFromMessage:(nonnull ROMessage *) withName:(nullable NSString *) (declared in ROComplexType)
- (void) readFromMessage:(nonnull ROMessage *)aMessage withName:(nullable NSString *)aName
Parameters:
- aMessage:
- aName:
readFromMessage:withName: readFromMessage:(ROMessage *) withName:(NSString *)
Metod deserializes SimpleRequestInfo with given name from given message
- (void) readFromMessage:(ROMessage *)aMessage withName:(NSString *)aName
Parameters:
- aMessage:
- aName:
writeToMessage:withName: writeToMessage:(nonnull ROMessage *) withName:(nullable NSString *) (declared in ROComplexType)
- (void) writeToMessage:(nonnull ROMessage *)aMessage withName:(nullable NSString *)aName
Parameters:
- aMessage:
- aName:
writeToMessage:withName: writeToMessage:(ROMessage *) withName:(NSString *)
Metod serializes SimpleRequestInfo with given name into given message.
- (void) writeToMessage:(ROMessage *)aMessage withName:(NSString *)aName
Parameters:
- aMessage:
- aName: