The metadata factory implementation. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory:

Public Member Functions
IMDecimalStringBuilder	DecimalBuilder (string name)
	Create a new decimal field metadata builder. More...

IMStringBuilder	StringBuilder (string name)
	Create a new string field metadata builder. More...

IMRecordBuilder	RecordBuilder (string name)
	Creates a new record metadata builder. More...

IMRecord	Record (string name, params IMField[] fields)
	Creates a new record metadata definition comprising the supplied fields, each with single multiplicity. More...

IMIntegerStringBuilder	IntegerBuilder (string name)
	Create a new integer field metadata builder. More...

IMCustomStringBuilder	CustomBuilder (string name, string handler)
	Create a new custom field metadata builder. More...

IMContentBuilder	ContentBuilder (string name)
	Creates a new content metadata builder. More...

IMContent	Content (string name, params IMRecord[] records)
	Creates a new content metadata definition comprising the supplied record definitions, each with single multiplicity. More...

IMString	String (string name)
	Convenience method to build a string field metadata definition. More...

IMString	String (string name, string defaultValue)
	Convenience method to build a string field metadata definition with a default value. More...

IMDecimalString	Decimal (string name)
	Convenience method to build a decimal field metadata definition with default scale of 2. More...

IMDecimalString	Decimal (string name, string defaultValue)
	Convenience method to build a decimal field metadata definition with a default value and a scale of 2. More...

IMDecimalString	Decimal (string name, double defaultValue)
	Convenience method to build a decimal field metadata definition with a default value and a scale of 2. More...

IMDecimalString	Decimal (string name, decimal defaultValue)
	Convenience method to build a decimal field metadata definition with a default value and a scale of 2. More...

IMIntegerString	Integer (string name)
	Convenience method to build an integer field metadata definition. More...

IMIntegerString	Integer (string name, string defaultValue)
	Convenience method to build an integer field metadata definition with a supplied default value. More...

IMIntegerString	Integer (string name, int defaultValue)
	Convenience method to build an integer field metadata definition with a supplied default value. More...

IMIntegerString	Integer (string name, decimal defaultValue)
	Convenience method to build an integer field metadata definition with a supplied default value. More...

IMCustomString	CustomString (string name, string handlerClass)
	Convenience method to build a custom field metadata definition. More...

string	EncodeAsXml (IMNode metadata)
	Encode metadata as xml. Equivalent to calling IMetadataFactory.EncodeAsXml(PushTechnology.ClientInterface.Client.Content.Metadata.IMNode,bool) with More...

string	EncodeAsXml (IMNode metadata, bool format)
	Encode metadata as xml. More...

IMNode	DecodeFromXml (string xml)
	Parse metadata from xml. The xml may have been created using IMetadataFactory.EncodeAsXml(PushTechnology.ClientInterface.Client.Content.Metadata.IMNode). More...

Detailed Description

The metadata factory implementation.

Member Function Documentation

IMContent PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.Content	(	string	name,
		params IMRecord[]	records
	)

Creates a new content metadata definition comprising the supplied record definitions, each with single multiplicity.

Parameters

name	The content definition name.
records	An array of record definitions representing single occurrence record instances within the content in the order specified.

Returns: New content metadata.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMContentBuilder PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.ContentBuilder ( string name )

Creates a new content metadata builder.

Parameters

name

Returns

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMCustomStringBuilder PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.CustomBuilder	(	string	name,
		string	handler
	)

Create a new custom field metadata builder.

Parameters

name	The field name.
handler	The full handler class name. This must specify the name of a class available at the server which will be instantiated to handle the field. The class must implement the required CustomFieldHandler interface.

Returns

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMCustomString PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.CustomString	(	string	name,
		string	handlerClass
	)

Convenience method to build a custom field metadata definition.

Parameters

name	The field name.
handlerClass	The full name of the handler class available at the server.

Returns: The custom string metadata definition.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMDecimalString PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.Decimal ( string name )

Convenience method to build a decimal field metadata definition with default scale of 2.

Parameters

name	The field name.

Returns: A new decimal field metadata definition.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMDecimalString PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.Decimal	(	string	name,
		string	defaultValue
	)

Convenience method to build a decimal field metadata definition with a default value and a scale of 2.

Parameters

name	The field name.
defaultValue	The default value which must be a valid decimal number representation.

Returns: A new decimal field metadata definition.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMDecimalString PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.Decimal	(	string	name,
		double	defaultValue
	)

Convenience method to build a decimal field metadata definition with a default value and a scale of 2.

Parameters

name	The field name.
defaultValue	The default value.

Returns: A new decimal field metadata definition.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMDecimalString PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.Decimal	(	string	name,
		decimal	defaultValue
	)

Convenience method to build a decimal field metadata definition with a default value and a scale of 2.

Parameters

name	The field name.
defaultValue	The default value which must be a valid decimal number representation.

Returns: A new decimal field metadata definition.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMDecimalStringBuilder PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.DecimalBuilder ( string name )

Create a new decimal field metadata builder.

Parameters

name	The field name.

Returns: A new builder for the named field.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMNode PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.DecodeFromXml ( string xml )

Parse metadata from xml. The xml may have been created using IMetadataFactory.EncodeAsXml(PushTechnology.ClientInterface.Client.Content.Metadata.IMNode).

Parameters

xml	A string containing an xml definition of metadata.

Returns: A populated metadata node.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

string PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.EncodeAsXml ( IMNode metadata )

Encode metadata as xml. Equivalent to calling IMetadataFactory.EncodeAsXml(PushTechnology.ClientInterface.Client.Content.Metadata.IMNode,bool) with

format=false.

Parameters

metadata The top-level node with the metadata definition to encode.

Returns: A string of unformatted xml.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

string PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.EncodeAsXml	(	IMNode	metadata,
		bool	format
	)

Encode metadata as xml.

Parameters

metadata	The top-level node with the metadata definition to encode.
format	Indicates whether the xml should be formatted.

Returns: A string of xml.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMIntegerString PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.Integer ( string name )

Convenience method to build an integer field metadata definition.

Parameters

name	The field name.

Returns: A new integer field metadata definition.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMIntegerString PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.Integer	(	string	name,
		string	defaultValue
	)

Convenience method to build an integer field metadata definition with a supplied default value.

Parameters

name	The field name.
defaultValue	The default value as a string. This must be a valid integer number representation.

Returns: A new integer field metadata definition.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMIntegerString PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.Integer	(	string	name,
		int	defaultValue
	)

Convenience method to build an integer field metadata definition with a supplied default value.

Parameters

name	The field name.
defaultValue	The default value.

Returns: A new integer field metadata definition.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMIntegerString PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.Integer	(	string	name,
		decimal	defaultValue
	)

Convenience method to build an integer field metadata definition with a supplied default value.

Parameters

name	The field name.
defaultValue	The default value.

Returns: A new integer field metadata definition.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMIntegerStringBuilder PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.IntegerBuilder ( string name )

Create a new integer field metadata builder.

Parameters

name	The field name.

Returns: A new builder for the named field.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMRecord PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.Record	(	string	name,
		params IMField[]	fields
	)

Creates a new record metadata definition comprising the supplied fields, each with single multiplicity.

Parameters

name	The record name.
fields	The array of field metadata definitions each representing a single occurrence field within the record in the order supplied.

Returns: New record metadata.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMRecordBuilder PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.RecordBuilder ( string name )

Creates a new record metadata builder.

Parameters

name	The name of the record.

Returns: A new record metadata builder.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMString PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.String ( string name )

Convenience method to build a string field metadata definition.

Parameters

name	The field name.

Returns: A new string field metadata definition.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMString PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.String	(	string	name,
		string	defaultValue
	)

Convenience method to build a string field metadata definition with a default value.

Parameters

name	The field name.
defaultValue	The default value.

Returns: A new string field metadata definition.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

IMStringBuilder PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.StringBuilder ( string name )

Create a new string field metadata builder.

Parameters

name	The name of the field.

Returns: A new builder for the named field.

Implements PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.

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

LegacyModule/Client/Content/Metadata/Record/MetadataFactory.cs

Public Member Functions

Detailed Description

Member Function Documentation