Diffusion .NET Client Library  6.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Public Member Functions | List of all members
PushTechnology.ClientInterface.Client.Content.IRecordFactory Interface Reference

Factory for record builders. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Content.IRecordFactory:
PushTechnology.ClientInterface.Client.Content.IContentFactory PushTechnology.ClientInterface.Client.Content.ContentFactory

Public Member Functions

IRecord NewRecord (params string[] fields)
 Create a new record comprising the supplied field values. More...
 
IRecord NewRecord (ICollection< object > fields)
 Create a new record comprising the supplied field values. More...
 
IRecordBuilder NewRecordBuilder ()
 Returns a new record builder. More...
 
IRecordStructuredBuilder NewRecordBuilder (IMRecord metadata)
 Returns a new structured record builder, i.e. one that uses IMRecord metadata, to enable field writes by name. More...
 
IRecordStructuredBuilder NewDeltaRecordBuilder (IMRecord metadata)
 Returns a new structured record builder (i.e. one that uses IMRecord metadata to enable field writes by name. More...
 

Detailed Description

Factory for record builders.

Member Function Documentation

IRecordStructuredBuilder PushTechnology.ClientInterface.Client.Content.IRecordFactory.NewDeltaRecordBuilder ( IMRecord  metadata)

Returns a new structured record builder (i.e. one that uses IMRecord metadata to enable field writes by name.

The record will have all fields initialised to the value that would indicate no change in a delta (i.e. a zero-length string).

This differs from NewRecordBuilder() in that it may be used to build record content that may be used to perform patch updates of record topics.

It should be noted that repeating fields will have the minimum number of occurrences set to zero-length string and will therefore need to be carefully manipulated to produce true deltas.

Parameters
metadataThe metadata to use.
Returns
A new structured record builder.

Implemented in PushTechnology.ClientInterface.Client.Content.ContentFactory.

IRecord PushTechnology.ClientInterface.Client.Content.IRecordFactory.NewRecord ( params string[]  fields)

Create a new record comprising the supplied field values.

Parameters
fieldsAn array of field values to populate the record.
Returns
A new immutable record populated with the supplied field values.

Implemented in PushTechnology.ClientInterface.Client.Content.ContentFactory.

IRecord PushTechnology.ClientInterface.Client.Content.IRecordFactory.NewRecord ( ICollection< object >  fields)

Create a new record comprising the supplied field values.

Parameters
fieldsA collection of field values to populate the record. If null then an empty record is created.
Returns
A new immutable record populated with the supplied field values.

Implemented in PushTechnology.ClientInterface.Client.Content.ContentFactory.

IRecordBuilder PushTechnology.ClientInterface.Client.Content.IRecordFactory.NewRecordBuilder ( )

Returns a new record builder.

Returns
A new record builder.

Implemented in PushTechnology.ClientInterface.Client.Content.ContentFactory.

IRecordStructuredBuilder PushTechnology.ClientInterface.Client.Content.IRecordFactory.NewRecordBuilder ( IMRecord  metadata)

Returns a new structured record builder, i.e. one that uses IMRecord metadata, to enable field writes by name.

The record will have all fields initialised to the default values indicated by the metadata.

Parameters
metadataThe metadata to use.
Returns
A new structured record builder.

Implemented in PushTechnology.ClientInterface.Client.Content.ContentFactory.

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