Class SepaBankToCustomerMessage

Namespace: Subsembly.Sepa

Assembly: Subsembly.Sepa.dll

Generic base class for all UNIFI Cash Management Messages (camt).

public abstract class SepaBankToCustomerMessage : SepaMessage

Inheritance: object

SepaObject

SepaMessage

SepaBankToCustomerMessage

Derived: SepaBankToCustomerAccountReport

SepaBankToCustomerDebitCreditNotification

SepaBankToCustomerStatement

Inherited Members: SepaMessage.MessageType

SepaMessage.MessageName

SepaMessage.MessageIdentification

SepaMessage.CreationDateTime

SepaMessage.WriteGroupHeaderFields(XmlWriter, SepaMessageInfo)

SepaMessage.ReadGroupHeaderFields(XmlReader, SepaMessageInfo)

SepaObject.TagName

SepaObject.IsMandatory

SepaObject.WriteXml(XmlWriter, SepaMessageInfo)

SepaObject.WriteXml(XmlWriter, SepaMessageInfo, string)

SepaObject.ReadXml(XmlReader, SepaMessageInfo)

SepaObject.ReadXml(XmlReader, SepaMessageInfo, string)

SepaObject.IsValid

SepaObject.Validate(ICollection<SepaException>, string)

SepaObject.OnWriteObjectXml(XmlWriter, SepaMessageInfo, string)

SepaObject.OnReadObjectXml(XmlReader, SepaMessageInfo, string)

SepaObject.OnAfterXmlRead(SepaMessageInfo)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This class provides the complete implementation of "camt.052", "camt.053", and "camt.054". Differences are handled when reading or writing XML by switching according to the actual message type.

Constructors

SepaBankToCustomerMessage(string, SepaMessageType)

public SepaBankToCustomerMessage(string sMessageTagName, SepaMessageType nMessageType)

Parameters

sMessageTagName string
nMessageType SepaMessageType

Fields

STMTTAG_ACCOUNTREPORT

The XML statement tag for messages of type BankToCustomerAccountReport.

public const string STMTTAG_ACCOUNTREPORT = "Rpt"

Field Value

string

STMTTAG_DEBITCREDITNOTIFICATION

The XML statement tag for messages of type BankToCustomerDebitCreditNotification.

public const string STMTTAG_DEBITCREDITNOTIFICATION = "Ntfctn"

Field Value

string

STMTTAG_STATEMENT

The XML statement tag for messages of type BankToCustomerStatement.

public const string STMTTAG_STATEMENT = "Stmt"

Field Value

string

Properties

AdditionalInformation

Additional information text pertaining to the message.

public string AdditionalInformation { get; set; }

Property Value

string: The additional information is optional and may be null.

IsEmpty

public override bool IsEmpty { get; }

Property Value

bool

LastPageIndicator

Indicates whether this was the last page of the message.

public bool? LastPageIndicator { get; set; }

Property Value

bool?

Remarks

If the PageNumber was set, then this LastPageIndicator must be set, too.

For compatibility with older versions of the Subsembly SEPA API, this is preset with the value true. If you do not want to have a MsgPgntn element in the output, then PageNumber and LastPageIndicator must be set to null.

MessageRecipient

The intended recipient for this message.

public SepaPartyIdentification MessageRecipient { get; }

Property Value

SepaPartyIdentification

PageNumber

Optional page number of this message.

public int? PageNumber { get; set; }

Property Value

int?

Remarks

If no page number is included with this statement, then this is null. If a page number is set, then it must be in the range from 0 to 99999.

Note that if a PageNumber was set, then the LastPageIndicator must be set, too.

For compatibility with older versions of the Subsembly SEPA API, this is preset with the value 1. If you do not want to have a MsgPgntn element in the output, then PageNumber and LastPageIndicator must be set to null.

Exceptions

ArgumentOutOfRangeException: An attempt was made to set a page number outside of the supported range.

Statement

Convenience accessor to the first statement of this bank to customer message.

public SepaStatement Statement { get; }

Property Value

SepaStatement

Remarks

If the Statements collection is empty, then reading this property will automatically create and add a new SepaStatement object to it. This is done in order to remain backward compatble with previous versions.

StatementTag

The XML tag used by the contained SepaStatement objects.

public string StatementTag { get; }

Property Value

string

Statements

The statement sequence of this SEPA document.

public SepaStatements Statements { get; }

Property Value

SepaStatements: This property is never null, but the SepaStatements instance may be empty.

Methods

Clear()

public override void Clear()

GetStatementTag(SepaMessageType)

public static string GetStatementTag(SepaMessageType nMessageType)

Parameters

nMessageType SepaMessageType

Returns

string

NewStatement()

Creates a new SepaStatement of a type that is appropriate to this container.

public SepaStatement NewStatement()

Returns

SepaStatement

OnReadXml(XmlReader, SepaMessageInfo)

protected override void OnReadXml(XmlReader aXmlReader, SepaMessageInfo aMessageInfo)

Parameters

aXmlReader XmlReader
aMessageInfo SepaMessageInfo

OnValidate(ICollection<SepaException>, string)

protected override void OnValidate(ICollection<SepaException> vErrors, string sPath)

Parameters

vErrors ICollection<SepaException>
sPath string

OnWriteXml(XmlWriter, SepaMessageInfo)

protected override void OnWriteXml(XmlWriter aXmlWriter, SepaMessageInfo aMessageInfo)

Parameters

aXmlWriter XmlWriter
aMessageInfo SepaMessageInfo