Class SepaPartyIdentification

A generic SEPA party identification (initiator, debtor, creditor, etc.).

Inheritance
object
SepaObject
SepaPartyIdentification
Implements
Inherited Members
Namespace: Subsembly.Sepa
Assembly: Subsembly.Sepa.dll
Syntax
public sealed class SepaPartyIdentification : SepaObject, ISepaNameAndAddress
Remarks

Currently this class primarily consists of a Name and a BIC property. However, it is likely that this class will be extended with postal address and other properties in the future.

Other SEPA object embed instances of the SepaPartyIdentification as needed. Please refer to the documentation of these other SEPA objects to learn which properties of the SepaPartyIdentification shall be set.

Constructors

SepaPartyIdentification(string, Fields, Fields)

Constructor.

Declaration
public SepaPartyIdentification(string sTagName, SepaPartyIdentification.Fields nSupportedFields, SepaPartyIdentification.Fields nRequiredFields = Fields.None)
Parameters
Type Name Description
string sTagName

The local name of the XML element tag to be used when reading or writing this object in XML format.
SepaPartyIdentification.Fields nSupportedFields

Fields that may occur in an instance of this party identfication.
SepaPartyIdentification.Fields nRequiredFields

Fields that must occur in an instance of this party identfication. If this is None, then the entire element is considered to be optional.
Remarks

An application usually does not need to create its own SepaPartyIdentification instances, but just uses the instances provided by other SEPA objects.

Properties

BIC

BIC of the party.

Declaration
public SepaBIC BIC { get; set; }
Property Value
Type Description
SepaBIC

Initial value is NullBIC.
Remarks

The value of this property may be used in different XML child elements, depending on context.

CreditorSchemeIdentification

Identifier of the creditor (CI).

Declaration
public string CreditorSchemeIdentification { get; set; }
Property Value
Type Description
string
Remarks

Optional creditor identifier (Gläubiger ID), if the party is a creditor. Must only occur in a related agent Creditor in a SepaTransactionDetails instance. Must be null in all other instances.

EBICSPartnerId

EBICS partner (customer) ID of this party.

Declaration
public string EBICSPartnerId { get; set; }
Property Value
Type Description
string
Remarks

This property is only used when this party identification is used for a "MsgRcpt" element. See MessageRecipient.

IsEmpty

Indicates if any supported property of this instance has been set at all.

Declaration
public override bool IsEmpty { get; }
Property Value
Type Description
bool
Overrides

Name

Name of the party.

Declaration
public string Name { get; set; }
Property Value
Type Description
string

The initial value of this property is null. Must not be longer than MaxNmLen characters.
Remarks

Only latin characters should be used. It is up to the caller to ensure that the provided string contains only characters accepted by the recipient of the SEPA document.

Exceptions
Type Condition
ArgumentException

An attempt was made to set a string longer than 70 characters.

OtherIdentification

Shortcut to the first entry of OtherIdentifications.

Declaration
public SepaOtherId OtherIdentification { get; }
Property Value
Type Description
SepaOtherId
Remarks

If the OtherIdentifications collection is empty, then accessing this property will add an empty SepaOtherId instance to it and return it.

OtherIdentifications

Some other party identifications.

Declaration
public SepaOtherIds OtherIdentifications { get; }
Property Value
Type Description
SepaOtherIds

PostalAddress

Postal address.

Declaration
public SepaPostalAddress PostalAddress { get; }
Property Value
Type Description
SepaPostalAddress

Methods

Clear()

Declaration
public override void Clear()
Overrides

OnReadXml(XmlReader, SepaMessageInfo)

Declaration
protected override void OnReadXml(XmlReader aXmlReader, SepaMessageInfo aMessageInfo)
Parameters
Type Name Description
XmlReader aXmlReader
SepaMessageInfo aMessageInfo
Overrides

OnValidate(ICollection<SepaException>, string)

Declaration
protected override void OnValidate(ICollection<SepaException> vErrors, string sPath)
Parameters
Type Name Description
ICollection<SepaException> vErrors
string sPath
Overrides

OnWriteXml(XmlWriter, SepaMessageInfo)

Declaration
protected override void OnWriteXml(XmlWriter aXmlWriter, SepaMessageInfo aMessageInfo)
Parameters
Type Name Description
XmlWriter aXmlWriter
SepaMessageInfo aMessageInfo
Overrides

Implements

See Also