Diffusion .NET Client Library  6.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Data.Record.IRecordV2 Interface Reference

The immutable value representing a list of records. More...

Inheritance diagram for PushTechnology.ClientInterface.Data.Record.IRecordV2:
PushTechnology.ClientInterface.Data.IBytes

Public Member Functions

IRecordV2Delta Diff (IRecordV2 original)
 Compares this value with an earlier version to calculate a structural delta. More...
 
IRecordModel AsModel (ISchema schema)
 Parses the value into a model based upon a specified schema. More...
 
IRecordModel AsValidatedModel (ISchema schema)
 Parses the value into a model based upon a specified schema. More...
 
List< List< string > > AsRecords ()
 Returns the data value as a list of lists of strings. More...
 
List< string > AsFields ()
 Returns the data value as a list of fields. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Data.IBytes
Stream AsInputStream ()
 Returns the data as a read-only stream. More...
 
byte[] ToByteArray ()
 Returns a copy of the data as a byte array. More...
 
void CopyTo (Stream outputStream)
 Writes the data to an output stream. More...
 

Additional Inherited Members

- Properties inherited from PushTechnology.ClientInterface.Data.IBytes
int Length [get]
 Returns the length of the data in bytes. More...
 

Detailed Description

The immutable value representing a list of records.

Implemented in Version 6.0.

Member Function Documentation

List<string> PushTechnology.ClientInterface.Data.Record.IRecordV2.AsFields ( )

Returns the data value as a list of fields.

This disregards record boundaries. If there is more than one record, they are concatenated to produce a list of all of the fields.

This method would normally only be used when it is known that there is only one record.

Returns
The new mutable list of all of the fields.
IRecordModel PushTechnology.ClientInterface.Data.Record.IRecordV2.AsModel ( ISchema  schema)

Parses the value into a model based upon a specified schema.

This assumes that data is compatible with the schema and does not do any validation. There is no need to validate the data if this has been done on entry or at the server. However, if the data is invalid then issues may occur when attempting to access it.

If it is not certain that the data is valid then the AsValidatedModel(ISchema) method may be used instead.

Parameters
schemaThe schema to use for parsing the data
Returns
The immutable model derived from the data value.
List<List<string> > PushTechnology.ClientInterface.Data.Record.IRecordV2.AsRecords ( )

Returns the data value as a list of lists of strings.

Returns
The new mutable list where each entry represents a record within the data.
IRecordModel PushTechnology.ClientInterface.Data.Record.IRecordV2.AsValidatedModel ( ISchema  schema)

Parses the value into a model based upon a specified schema.

Parameters
schemaThe schema to use for parsing the data.
Returns
The model derived from the value.
IRecordV2Delta PushTechnology.ClientInterface.Data.Record.IRecordV2.Diff ( IRecordV2  original)

Compares this value with an earlier version to calculate a structural delta.

Parameters
originalThe original value to compare with this value.
Returns
The structural delta representing the difference between the original and this value.

The documentation for this interface was generated from the following file: