Class EbicsFileSpoolerJournal

Namespace

Subsembly.EBICS

Assembly

Subsembly.EBICS.Core.dll

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

public class EbicsFileSpoolerJournal : EbicsElement

Inheritance

object

EbicsElement

EbicsFileSpoolerJournal

Inherited Members

EbicsElement.BuildXmlDocument(EbicsVersion)

EbicsElement.Load(Stream, EbicsVersion)

EbicsElement.Load(string, EbicsVersion)

EbicsElement.Save(Stream, EbicsVersion)

EbicsElement.Save(string, EbicsVersion)

EbicsElement.FromBuffer(EbicsDataBuffer, EbicsVersion)

EbicsElement.ToBuffer(EbicsVersion)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

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.

public EbicsFileSpoolerJournalEntry[] JournalEntries { get; }

Property Value

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.

public DateTime LastProtocolDate { get; }

Property Value

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.

public EbicsFileTransferResult LastProtocolResult { get; }

Property Value

EbicsFileTransferResult

Methods

AddJournalEntry(EbicsFileSpoolerJournalEntry)

public void AddJournalEntry(EbicsFileSpoolerJournalEntry aJournalEntry)

Parameters

aJournalEntry EbicsFileSpoolerJournalEntry

BuildXml(XmlDocument, EbicsVersion)

public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument

nVersion EbicsVersion

Returns

XmlElement

FindJournalEntry(string)

public EbicsFileSpoolerJournalEntry FindJournalEntry(string sOrderID)

Parameters

sOrderID string

Returns

EbicsFileSpoolerJournalEntry

LoadJournal(EbicsFileSpoolerFolder, EbicsFileFolder)

public static EbicsFileSpoolerJournal LoadJournal(EbicsFileSpoolerFolder aSpoolerFolder, EbicsFileFolder aOutboxFolder)

Parameters

aSpoolerFolder EbicsFileSpoolerFolder

aOutboxFolder EbicsFileFolder

Returns

EbicsFileSpoolerJournal

ParseXml(XmlElement, EbicsVersion)

public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)

Parameters

xmlElement XmlElement

nVersion EbicsVersion

ProcessProtocolData(EbicsOrderProtocol)

public bool ProcessProtocolData(EbicsOrderProtocol aOrder)

Parameters

aOrder EbicsOrderProtocol

Returns

bool

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)

public void SaveJournal(EbicsFileSpoolerFolder aSpoolerFolder, EbicsFileFolder aOutboxFolder)

Parameters

aSpoolerFolder EbicsFileSpoolerFolder

aOutboxFolder EbicsFileFolder