Class SecuritiesGenericField

Base class for all generic SWIFT field implementations.

Inheritance
System.Object
SecuritiesField
SecuritiesGenericField
SecuritiesAccountField
SecuritiesAmountField
SecuritiesBalanceField
SecuritiesCurrencyField
SecuritiesDateTimeField
SecuritiesIndicatorField<TEnum>
SecuritiesNarrativeField
SecuritiesNumberCountField
SecuritiesPartyField
SecuritiesPeriodField
SecuritiesPlaceCountryField
SecuritiesPlaceField
SecuritiesPriceField
SecuritiesQuantityField
SecuritiesRateField
SecuritiesReferenceField
SecuritiesStructuredNarrativeField
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Subsembly.Swift.SecuritiesMarkets
Assembly: Subsembly.Sepa.dll
Syntax
public abstract class SecuritiesGenericField : SecuritiesField, ISecuritiesSequence

Properties

DataSourceScheme

Declaration
public string DataSourceScheme { get; set; }
Property Value
Type Description
System.String

IsEmpty

Must be overridden to indicate whether the field has not been initialized. An empty field would not be generated when generating the SWIFT message.

Declaration
public abstract override bool IsEmpty { get; }
Property Value
Type Description
System.Boolean
Overrides

IsValid

Declaration
public sealed override bool IsValid { get; }
Property Value
Type Description
System.Boolean
Overrides

Qualifier

Declaration
public string Qualifier { get; set; }
Property Value
Type Description
System.String

QualifierProvision

Declaration
public string QualifierProvision { get; }
Property Value
Type Description
System.String

Tag

Declaration
public string Tag { get; set; }
Property Value
Type Description
System.String

TagProvision

Declaration
public string TagProvision { get; }
Property Value
Type Description
System.String

Methods

Clear()

Declaration
public override void Clear()
Overrides

GenerateField()

Generate a SwiftField based on the content of this instance.

Declaration
public override SwiftField GenerateField()
Returns
Type Description
SwiftField
Overrides
Remarks

If the value of this Tag property is null, and there is no TagProvision without wildcard, then the derived class must provide a field tag through OnChooseFieldTag().

Exceptions
Type Condition
SwiftException

MatchField(SwiftField)

Checks whether a SwiftField matches the provisions of this SecuritiesGenericField.

Declaration
public override bool MatchField(SwiftField aField)
Parameters
Type Name Description
SwiftField aField

The field to match. Must not be null.
Returns
Type Description
System.Boolean

If the given field matches TagProvision and QualifierProvision, then true is returned. If not, then false is returned.
Overrides

OnChooseFieldTag()

May be overridden to provide a field tag based on the current field data.

Declaration
protected virtual string OnChooseFieldTag()
Returns
Type Description
System.String
Remarks

The default implementation always returns null.

OnClear()

Must be overridden to clear out all field content data.

Declaration
protected abstract void OnClear()

OnGenerateFieldContent(String, String)

Must be overridden to create the field content based on the given parameters and the current field data.

Declaration
protected abstract string OnGenerateFieldContent(string sTag, string sQualifier)
Parameters
Type Name Description
System.String sTag

The tag of the field that shall be generated. This is never null.
System.String sQualifier

The qualifier of the field that shall be generated. This is never null.
Returns
Type Description
System.String

The content for SwiftField.Content.

OnParseFieldContent(SwiftField)

Declaration
protected abstract void OnParseFieldContent(SwiftField aField)
Parameters
Type Name Description
SwiftField aField

OnValidate()

Must be overridden to validae the current field and return information about problems indicate whether the field is correctly initialized an the field content can be generated.

Declaration
protected abstract string OnValidate()
Returns
Type Description
System.String

If the field is valid, then null shall be returned. Otherwise a human readable error description shall be returned.

ProcessField(SwiftField)

Declaration
public override void ProcessField(SwiftField aField)
Parameters
Type Name Description
SwiftField aField
Overrides

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Implements