Diffusion .NET Classic API - Core and Common  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord Interface Reference

More...

Inheritance diagram for PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord:
PushTechnology.DiffusionCore.Messaging.Data.metadata.IMNode PushTechnology.DiffusionCore.Messaging.Data.metadata.IMMessage PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl PushTechnology.DiffusionCore.Messaging.Data.metadata.MMessageImpl PushTechnology.DiffusionCore.Messaging.Data.metadata.MMessageImpl PushTechnology.DiffusionCore.Messaging.Data.metadata.record.MRecordRecord PushTechnology.DiffusionCore.Messaging.Data.metadata.record.MRecordMessage PushTechnology.DiffusionCore.Messaging.Data.metadata.record.MRecordMessage

Public Member Functions

IMRecord AddRecord (string name)
 Adds a new child record with default multiplicity. More...
 
IMRecord AddRecord (string name, Multiplicity multiplicity)
 Adds a new child record. More...
 
IMField AddField (string name)
 Adds a new child field with default multiplicity and data type. More...
 
IMField AddField (string name, Multiplicity multiplicity)
 Adds a new child field with default data type. More...
 
IMField AddField (string name, MDataType dataType)
 Adds a new child field with default multiplicity. More...
 
IMField AddField (string name, MDataType dataType, Multiplicity multiplicity)
 Adds a new child field. More...
 
IMField AddCustomField (string name, Multiplicity multiplicity, ICustomFieldHandler handler)
 Adds a new child field with custom data type. More...
 
IMField AddCustomField (string name, Multiplicity multiplicity, string handler)
 Adds a new child field with custom data type. More...
 
IMRecord GetRecord (string name)
 Gets a child record by name. More...
 
IMField GetField (string name)
 Gets a child field by name. More...
 
IMNode GetChild (int index)
 Gets the child at a given index. More...
 

Properties

List< IMNodeChildNodes [get]
 Returns a list of the children of the record. More...
 
int ChildCount [get]
 Returns the number of child nodes defined. More...
 

Detailed Description

Member Function Documentation

IMField PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.AddCustomField ( string  name,
Multiplicity  multiplicity,
ICustomFieldHandler  handler 
)

Adds a new child field with custom data type.

Parameters
nameThe name of the child field.
multiplicityThe multiplicity of the child field within this record.
handlerA custom field handler that defines the behaviour of the custom data type.
Returns
The new child field.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl.

IMField PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.AddCustomField ( string  name,
Multiplicity  multiplicity,
string  handler 
)

Adds a new child field with custom data type.

Parameters
nameThe name of the child field.
multiplicityThe multiplicity of the child field within this record.
handlerThe class name of a custom field handler that defines the behaviour of the custom data type.
Returns
The new child field.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl.

IMField PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.AddField ( string  name)

Adds a new child field with default multiplicity and data type.

Parameters
nameThe name of the child field.
Returns
The new child field.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl.

IMField PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.AddField ( string  name,
Multiplicity  multiplicity 
)

Adds a new child field with default data type.

Parameters
nameThe name of the child field.
multiplicityThe multiplicity of the child field within this record.
Returns
The new child field.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl.

IMField PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.AddField ( string  name,
MDataType  dataType 
)

Adds a new child field with default multiplicity.

Default multiplicity may vary by implementation but is typically singleRequired.

Parameters
nameThe name of the child field.
dataTypeTHe data type of the child field.
Returns
The new child field.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl.

IMField PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.AddField ( string  name,
MDataType  dataType,
Multiplicity  multiplicity 
)

Adds a new child field.

Parameters
nameThe name of the child field.
dataTypeThe data type of the child field.
multiplicityThe multiplicity of the child field within this record.
Returns
The new child field.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl.

IMRecord PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.AddRecord ( string  name)

Adds a new child record with default multiplicity.

Default multiplicity may vary by implementation but is typically singleRequired.

Parameters
nameThe name of the child record.
Returns
The new child record.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl.

IMRecord PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.AddRecord ( string  name,
Multiplicity  multiplicity 
)

Adds a new child record.

Parameters
nameThe name of the child record.
multiplicityThe multiplicity of the child record within this record.
Returns
The new child record.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl.

IMNode PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.GetChild ( int  index)

Gets the child at a given index.

Parameters
indexThe index.
Returns
The child at the given index.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl.

IMField PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.GetField ( string  name)

Gets a child field by name.

Parameters
nameThe field name.
Returns
The named child field, or null if no child field with the given name exists.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl.

IMRecord PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.GetRecord ( string  name)

Gets a child record by name.

Parameters
nameThe record name.
Returns
The named child record, or null if no child record with the given name exists.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MRecordImpl.

Property Documentation

int PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.ChildCount
get

Returns the number of child nodes defined.

List<IMNode> PushTechnology.DiffusionCore.Messaging.Data.metadata.IMRecord.ChildNodes
get

Returns a list of the children of the record.