Interface IRecordV2
The immutable value representing a list of records.
Namespace: PushTechnology.ClientInterface.Data.Record
Assembly: Diffusion.Client.dll
Syntax
public interface IRecordV2 : IBytesRemarks
Implemented in Version 6.0.
Methods
AsFields()
Returns the data value as a list of fields.
Declaration
List<string> AsFields()Returns
| Type | Description |
|---|---|
| List<System.String> | The new mutable list of all of the fields. |
Remarks
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.
AsModel(ISchema)
Parses the value into a model based upon a specified schema.
Declaration
IRecordModel AsModel(ISchema schema)Parameters
| Type | Name | Description |
|---|---|---|
| ISchema | schema | The schema to use for parsing the data. |
Returns
| Type | Description |
|---|---|
| IRecordModel | The immutable model derived from the data value. |
Remarks
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.
AsRecords()
Returns the data value as a list of lists of strings.
Declaration
List<List<string>> AsRecords()Returns
| Type | Description |
|---|---|
| List<List<System.String>> | The new mutable list where each entry represents a record within the data. |
AsValidatedModel(ISchema)
Parses the value into a model based upon a specified schema.
Declaration
IRecordModel AsValidatedModel(ISchema schema)Parameters
| Type | Name | Description |
|---|---|---|
| ISchema | schema | The schema to use for parsing the data. |
Returns
| Type | Description |
|---|---|
| IRecordModel | The model derived from the value. |
Diff(IRecordV2)
Compares this value with an earlier version to calculate a structural delta.
Declaration
IRecordV2Delta Diff(IRecordV2 original)Parameters
| Type | Name | Description |
|---|---|---|
| IRecordV2 | original | The original value to compare with this value. |
Returns
| Type | Description |
|---|---|
| IRecordV2Delta | The structural delta representing the difference between the original and this value. |