Class EbicsFileSpoolerJournal

Contains the status and protocols from processing the orders in the BOX_OUTBOX.

Inheritance
System.Object
EbicsElement
EbicsFileSpoolerJournal
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)
System.Object.ToString()
Namespace: Subsembly.EBICS
Assembly: Subsembly.EBICS.Core.dll
Syntax
public class EbicsFileSpoolerJournal : EbicsElement
Remarks

A single instance of this class is stored as JOURNALFILENAME inside of the BOX_OUTBOX.

Properties

JournalEntries

Collection of EbicsFileSpoolerJournalEntry instances that have been collected for the orders tracked in this outbox.

Declaration
public EbicsFileSpoolerJournalEntry[] JournalEntries { get; }
Property Value
Type Description
EbicsFileSpoolerJournalEntry[]

This is never null, but may be an empty array.

LastProtocolDate

The date (without time) when the last successful protocol download was added to this journal.

Declaration
public DateTime LastProtocolDate { get; }
Property Value
Type Description
System.DateTime
Remarks

The time zone of this value is ignored. It is serialized without any time zone information. Therefore, when loaded its DateTimeKind is Unspecified.

LastProtocolResult

The result of the last EBICS protocol download tracked in this journal.

Declaration
public EbicsFileTransferResult LastProtocolResult { get; }
Property Value
Type Description
EbicsFileTransferResult

Methods

AddJournalEntry(EbicsFileSpoolerJournalEntry)

Declaration
public void AddJournalEntry(EbicsFileSpoolerJournalEntry aJournalEntry)
Parameters
Type Name Description
EbicsFileSpoolerJournalEntry aJournalEntry

BuildXml(XmlDocument, EbicsVersion)

Declaration
public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)
Parameters
Type Name Description
System.Xml.XmlDocument xmlDocument
EbicsVersion nVersion
Returns
Type Description
System.Xml.XmlElement
Overrides

FindJournalEntry(String)

Declaration
public EbicsFileSpoolerJournalEntry FindJournalEntry(string sOrderID)
Parameters
Type Name Description
System.String sOrderID
Returns
Type Description
EbicsFileSpoolerJournalEntry

LoadJournal(EbicsFileSpoolerFolder, EbicsFileFolder)

Declaration
public static EbicsFileSpoolerJournal LoadJournal(EbicsFileSpoolerFolder aSpoolerFolder, EbicsFileFolder aOutboxFolder)
Parameters
Type Name Description
EbicsFileSpoolerFolder aSpoolerFolder
EbicsFileFolder aOutboxFolder
Returns
Type Description
EbicsFileSpoolerJournal

ParseXml(XmlElement, EbicsVersion)

Declaration
public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement
EbicsVersion nVersion
Overrides

ProcessProtocolData(EbicsOrderProtocol)

Declaration
public bool ProcessProtocolData(EbicsOrderProtocol aOrder)
Parameters
Type Name Description
EbicsOrderProtocol aOrder
Returns
Type Description
System.Boolean

The return value indicates whether any changes to this journal have been made. If the return valus is true, then this updated journal should be saved. If the return value is false, then nothing has changed, and it is not necessary to save this journal.

SaveJournal(EbicsFileSpoolerFolder, EbicsFileFolder)

Declaration
public void SaveJournal(EbicsFileSpoolerFolder aSpoolerFolder, EbicsFileFolder aOutboxFolder)
Parameters
Type Name Description
EbicsFileSpoolerFolder aSpoolerFolder
EbicsFileFolder aOutboxFolder