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
- Unit: DataAbstractSimple_Intf.pas
- Ancestry: TCollectionItem | TROComplexType | SimpleRequestInfo
constructor Create reintroduce overload virtual (declared in TROComplexType)
Creates a new instance.
constructor Create
constructor Create (TCollection) overload override (declared in TROComplexType)
Creates a new instance with given parameter.
constructor Create(aCollection: TCollection)
Parameters:
- aCollection: collection
Assign override
Copies data from a given source.
procedure Assign(Source: TPersistent)
Parameters:
- Source: Instance whose properties will be copied
AssignTo override (declared in TROComplexType)
Copies the properties of an object to a destination object.
procedure AssignTo(iDest: TPersistent)
Parameters:
- iDest: destination object.
Clone (declared in TROComplexType)
Creates and returns a second copy of the struct.
The new instance will be a deep copy of the original struct, all nested members that are arrays, structs or binaries will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent from the original class.
function Clone: TROComplexType
ContentAsJson (declared in TROComplexType)
property ContentAsJson: UnicodeString read
ContentAsString (declared in TROComplexType)
Returns the structure of the type in a string format.
property ContentAsString: string read
ContentAsXml (declared in TROComplexType)
Returns the XML structure of the type in a string format.
property ContentAsXml: ROUTF8String read
FieldCount (declared in TROComplexType)
property FieldCount: Integer read
FieldInfo (declared in TROComplexType)
property FieldInfo[Index: Integer]: PTypeInfo read
FieldName (declared in TROComplexType)
property FieldName[Index: Integer]: string read
FreeInternalProperties protected override
procedure FreeInternalProperties
GetAttributeCount virtual (declared in TROComplexType)
Returns the number of custom attributes defined for the class.
class function GetAttributeCount: Integer
GetAttributeName virtual (declared in TROComplexType)
Returns the name of custom attribute defined for the class, with the specified index.
class function GetAttributeName(aIndex: Integer): string
Parameters:
- aIndex: The index of attribute.
GetAttributeValue virtual (declared in TROComplexType)
Returns the value of custom attribute defined for the class, with the specified index.
class function GetAttributeValue(aIndex: Integer): string
Parameters:
- aIndex: The index of attribute.
GetContentAsJson (declared in TROComplexType)
function GetContentAsJson(aIncludeExtraInfo: Boolean): UnicodeString
Parameters:
- aIncludeExtraInfo:
GetContentAsXml (declared in TROComplexType)
function GetContentAsXml(aOffset: Integer): ROUTF8String
Parameters:
- aOffset:
GetFieldNames (declared in TROComplexType)
procedure GetFieldNames(aList: TStrings)
Parameters:
- aList:
GetFieldValue (declared in TROComplexType)
function GetFieldValue(const aFieldName: string): Variant
Parameters:
- aFieldName:
IncludeSchema
When returning the data, include the field information.
property IncludeSchema: Boolean read write
MaxRecords
Maximum number of records to return. <1 is infinite.
property MaxRecords: Integer read write
Parameters
List of parameters for this request.
property Parameters: SimpleDataParameterArray read write
ReadComplex override
Deserializes current class instance using provided serializer.
procedure ReadComplex(aSerializer: TObject)
Parameters:
- aSerializer: Data source (type TROSerializer).
SaveToJson protected virtual (declared in TROComplexType)
procedure SaveToJson(const aRoot: TROJSONValue; aIncludeExtraInfo: Boolean)
Parameters:
- aRoot:
- aIncludeExtraInfo:
SaveToXml protected virtual (declared in TROComplexType)
procedure SaveToXml(const aNode: TROConverterNode)
Parameters:
- aNode:
SetFieldValue (declared in TROComplexType)
procedure SetFieldValue(const aFieldName: string; const aValue: Variant)
Parameters:
- aFieldName:
- aValue:
SimpleMode
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 SimpleMode: Boolean read write
SmartAssign (declared in TROComplexType)
Copies specific data from a given source.
procedure SmartAssign(Source: TPersistent; TypeKinds: TTypeKinds)
Parameters:
- Source: Instance whose properties will be copied
- TypeKinds: Specifies which properties should be copied
SQL
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 SQL: ROUTF8String read write
Table
Table to request.
property Table: ROUTF8String read write
TryGetAttribute (declared in TROComplexType)
class function TryGetAttribute(aName: string; out aValue: string): Boolean
Parameters:
- aName:
- aValue:
Where
Where condition to use. This should be formatted along the lines of sql where expressions.
property Where: ROUTF8String read write
WriteComplex override
Serializes current class instance using provided serializer.
procedure WriteComplex(aSerializer: TObject)
Parameters:
- aSerializer: Data sink (type TROSerializer)
ContentAsJson (declared in TROComplexType)
property ContentAsJson: UnicodeString read
ContentAsString (declared in TROComplexType)
Returns the structure of the type in a string format.
property ContentAsString: string read
ContentAsXml (declared in TROComplexType)
Returns the XML structure of the type in a string format.
property ContentAsXml: ROUTF8String read
FieldCount (declared in TROComplexType)
property FieldCount: Integer read
FieldInfo (declared in TROComplexType)
property FieldInfo[Index: Integer]: PTypeInfo read
FieldName (declared in TROComplexType)
property FieldName[Index: Integer]: string read
IncludeSchema
When returning the data, include the field information.
property IncludeSchema: Boolean read write
MaxRecords
Maximum number of records to return. <1 is infinite.
property MaxRecords: Integer read write
Parameters
List of parameters for this request.
property Parameters: SimpleDataParameterArray read write
SimpleMode
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 SimpleMode: Boolean read write
SQL
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 SQL: ROUTF8String read write
Table
Table to request.
property Table: ROUTF8String read write
Where
Where condition to use. This should be formatted along the lines of sql where expressions.
property Where: ROUTF8String read write
GetAttributeCount virtual (declared in TROComplexType)
Returns the number of custom attributes defined for the class.
class function GetAttributeCount: Integer
GetAttributeName virtual (declared in TROComplexType)
Returns the name of custom attribute defined for the class, with the specified index.
class function GetAttributeName(aIndex: Integer): string
Parameters:
- aIndex: The index of attribute.
GetAttributeValue virtual (declared in TROComplexType)
Returns the value of custom attribute defined for the class, with the specified index.
class function GetAttributeValue(aIndex: Integer): string
Parameters:
- aIndex: The index of attribute.
TryGetAttribute (declared in TROComplexType)
class function TryGetAttribute(aName: string; out aValue: string): Boolean
Parameters:
- aName:
- aValue:
constructor Create reintroduce overload virtual (declared in TROComplexType)
Creates a new instance.
constructor Create
constructor Create (TCollection) overload override (declared in TROComplexType)
Creates a new instance with given parameter.
constructor Create(aCollection: TCollection)
Parameters:
- aCollection: collection
Assign override
Copies data from a given source.
procedure Assign(Source: TPersistent)
Parameters:
- Source: Instance whose properties will be copied
AssignTo override (declared in TROComplexType)
Copies the properties of an object to a destination object.
procedure AssignTo(iDest: TPersistent)
Parameters:
- iDest: destination object.
Clone (declared in TROComplexType)
Creates and returns a second copy of the struct.
The new instance will be a deep copy of the original struct, all nested members that are arrays, structs or binaries will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent from the original class.
function Clone: TROComplexType
FreeInternalProperties protected override
procedure FreeInternalProperties
GetContentAsJson (declared in TROComplexType)
function GetContentAsJson(aIncludeExtraInfo: Boolean): UnicodeString
Parameters:
- aIncludeExtraInfo:
GetContentAsXml (declared in TROComplexType)
function GetContentAsXml(aOffset: Integer): ROUTF8String
Parameters:
- aOffset:
GetFieldNames (declared in TROComplexType)
procedure GetFieldNames(aList: TStrings)
Parameters:
- aList:
GetFieldValue (declared in TROComplexType)
function GetFieldValue(const aFieldName: string): Variant
Parameters:
- aFieldName:
ReadComplex override
Deserializes current class instance using provided serializer.
procedure ReadComplex(aSerializer: TObject)
Parameters:
- aSerializer: Data source (type TROSerializer).
SaveToJson protected virtual (declared in TROComplexType)
procedure SaveToJson(const aRoot: TROJSONValue; aIncludeExtraInfo: Boolean)
Parameters:
- aRoot:
- aIncludeExtraInfo:
SaveToXml protected virtual (declared in TROComplexType)
procedure SaveToXml(const aNode: TROConverterNode)
Parameters:
- aNode:
SetFieldValue (declared in TROComplexType)
procedure SetFieldValue(const aFieldName: string; const aValue: Variant)
Parameters:
- aFieldName:
- aValue:
SmartAssign (declared in TROComplexType)
Copies specific data from a given source.
procedure SmartAssign(Source: TPersistent; TypeKinds: TTypeKinds)
Parameters:
- Source: Instance whose properties will be copied
- TypeKinds: Specifies which properties should be copied
WriteComplex override
Serializes current class instance using provided serializer.
procedure WriteComplex(aSerializer: TObject)
Parameters:
- aSerializer: Data sink (type TROSerializer)
-
SimpleRequestInfo Class:
- .NET
- Xcode
- Delphi