Class EbicsFileSpoolerJournal
Contains the status and protocols from processing the orders in the BOX_OUTBOX.
public class EbicsFileSpoolerJournal : EbicsElement
- Inheritance
-
EbicsFileSpoolerJournal
- Inherited Members
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
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
Methods
AddJournalEntry(EbicsFileSpoolerJournalEntry)
public void AddJournalEntry(EbicsFileSpoolerJournalEntry aJournalEntry)
Parameters
aJournalEntryEbicsFileSpoolerJournalEntry
BuildXml(XmlDocument, EbicsVersion)
public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)
Parameters
xmlDocumentXmlDocumentnVersionEbicsVersion
Returns
FindJournalEntry(string)
public EbicsFileSpoolerJournalEntry FindJournalEntry(string sOrderID)
Parameters
sOrderIDstring
Returns
LoadJournal(EbicsFileSpoolerFolder, EbicsFileFolder)
public static EbicsFileSpoolerJournal LoadJournal(EbicsFileSpoolerFolder aSpoolerFolder, EbicsFileFolder aOutboxFolder)
Parameters
aSpoolerFolderEbicsFileSpoolerFolderaOutboxFolderEbicsFileFolder
Returns
ParseXml(XmlElement, EbicsVersion)
public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)
Parameters
xmlElementXmlElementnVersionEbicsVersion
ProcessProtocolData(EbicsOrderProtocol)
public bool ProcessProtocolData(EbicsOrderProtocol aOrder)
Parameters
aOrderEbicsOrderProtocol
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 isfalse, then nothing has changed, and it is not necessary to save this journal.
SaveJournal(EbicsFileSpoolerFolder, EbicsFileFolder)
public void SaveJournal(EbicsFileSpoolerFolder aSpoolerFolder, EbicsFileFolder aOutboxFolder)
Parameters
aSpoolerFolderEbicsFileSpoolerFolderaOutboxFolderEbicsFileFolder