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

Defines the multiplicity of a metadata field or record node within its parent message or record. More...

Public Member Functions

 Multiplicity ()
 Constructor. More...
 
 Multiplicity (int number)
 Constructor for a fixed multiplicity (where there ar a fixed number of occurrences). More...
 
 Multiplicity (int minimum, int maximum)
 Constructor. More...
 
override bool Equals (object obj)
 Override. More...
 
override int GetHashCode ()
 Get the hash code. More...
 
override string ToString ()
 Convert this object to a human-readable string. More...
 

Static Public Attributes

static Multiplicity singleRequired
 Static instance of a multiplicity of 1 (single required). More...
 
static Multiplicity singleOptional
 Static instance of a multiplicity of 0..1 (single optional). More...
 

Properties

int Minimum [get, set]
 The minimum value - must be zero or greater. More...
 
int Maximum [get, set]
 The maximum value - must be greater than 0 and greater than or equal to the minimum OR -1 to indicate no maximum limit. More...
 
bool HasMaximum [get]
 Indicates whether there is a maximum number of occurrences (i.e. maximum not -1). Returns true if the maximum is not -1. More...
 
bool IsRepeating [get]
 Indicates whether this is a 'repeating' multiplicity, meaning it defines more than one possible occurrence. More...
 
bool IsSingle [get]
 Indicates whether this is 'single' multiplicity meaning that only 1 (or 0 if optional) occurrences can exist. Returns true if single multiplicity. More...
 
bool IsSingleRequired [get]
 Indicates whether this is a 'single required' multiplicity (i.e. a multiplicity of 1). More...
 
bool IsSingleOptional [get]
 Indiciates whether this is a 'single optional' multiplicity (i.e. a multiplicity of 0..1). More...
 
bool IsFixed [get]
 Indicates whether this is variable multiplicity (i.e. the minimum and maximum values are different). Returns true if variable, false if fixed. More...
 
bool IsVariable [get]
 Indicates whether this is variable multiplicity (i.e. the minimum and maximum values are different). More...
 

Detailed Description

Defines the multiplicity of a metadata field or record node within its parent message or record.

Constructor & Destructor Documentation

PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.Multiplicity ( )

Constructor.

PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.Multiplicity ( int  number)

Constructor for a fixed multiplicity (where there ar a fixed number of occurrences).

Parameters
numberThe number of occurrences - must be greater than 0.
PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.Multiplicity ( int  minimum,
int  maximum 
)

Constructor.

Parameters
minimumThe minimum number of occurrences. Must be zero or greater.
maximumThe maximum number of

Member Function Documentation

override bool PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.Equals ( object  obj)

Override.

Parameters
obj
Returns
override int PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.GetHashCode ( )

Get the hash code.

Returns
override string PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.ToString ( )

Convert this object to a human-readable string.

Returns

Member Data Documentation

Multiplicity PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.singleOptional
static

Static instance of a multiplicity of 0..1 (single optional).

Multiplicity PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.singleRequired
static

Static instance of a multiplicity of 1 (single required).

Property Documentation

bool PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.HasMaximum
get

Indicates whether there is a maximum number of occurrences (i.e. maximum not -1). Returns true if the maximum is not -1.

bool PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.IsFixed
get

Indicates whether this is variable multiplicity (i.e. the minimum and maximum values are different). Returns true if variable, false if fixed.

bool PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.IsRepeating
get

Indicates whether this is a 'repeating' multiplicity, meaning it defines more than one possible occurrence.

bool PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.IsSingle
get

Indicates whether this is 'single' multiplicity meaning that only 1 (or 0 if optional) occurrences can exist. Returns true if single multiplicity.

bool PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.IsSingleOptional
get

Indiciates whether this is a 'single optional' multiplicity (i.e. a multiplicity of 0..1).

bool PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.IsSingleRequired
get

Indicates whether this is a 'single required' multiplicity (i.e. a multiplicity of 1).

bool PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.IsVariable
get

Indicates whether this is variable multiplicity (i.e. the minimum and maximum values are different).

int PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.Maximum
getset

The maximum value - must be greater than 0 and greater than or equal to the minimum OR -1 to indicate no maximum limit.

int PushTechnology.DiffusionCore.Messaging.Data.metadata.Multiplicity.Minimum
getset

The minimum value - must be zero or greater.