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

The IRecordV2 schema. More...

Public Member Functions

IMutableRecordModel CreateMutableModel ()
 Creates a mutable model based on this schema. More...
 
string ToJSONString ()
 Returns the schema in a JSON format. More...
 

Properties

IReadOnlyList< IRecordRecords [get]
 Returns an immutable, ordered list of record definitions. More...
 

Detailed Description

The IRecordV2 schema.

A schema describes data value format in terms of one or more record definitions. A record definition describes the layout of a record and comprises one or more field definitions.

Within the data value there can be multiple occurrences of a record or field described by a single definition. The defined (or allowed, when describing variable numbers) number of occurrences of each definition is referred to as its 'multiplicity'. The multiplicity can be fixed (the item occurs a fixed number of times), or variable (the item occurs from a minimum number of times to a maximum number of times). If a variable field is used it must be the last in a record definition and if a variable record is used it must be the last in the schema definition.

A field may be defined as of type 'string', 'integer' or 'decimal'. A decimal type has a further property of 'scale' which defines the number of digits to the right of the decimal point.

Implemented in Version 6.0.

Member Function Documentation

IMutableRecordModel PushTechnology.ClientInterface.Data.Record.Schema.ISchema.CreateMutableModel ( )

Creates a mutable model based on this schema.

The model will be created with all mandatory record occurrences and all mandatory field occurrences initialized to default values.

Such a model may be mutated and used to generate updated IRecordV2 occurrences for updating purposes.

Returns
The new initialized model based on this schema.
string PushTechnology.ClientInterface.Data.Record.Schema.ISchema.ToJSONString ( )

Returns the schema in a JSON format.

Returns
The current schema as a JSON formatted string.

Property Documentation

IReadOnlyList<IRecord> PushTechnology.ClientInterface.Data.Record.Schema.ISchema.Records
get

Returns an immutable, ordered list of record definitions.

There will be at least one item in the list.


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