Class EbicsFileSpoolerJournalEntry

Represents a single entry in the EbicsFileSpoolerJournal.

Inheritance
object
EbicsElement
EbicsFileSpoolerJournalEntry
Implements
Inherited Members
Namespace: Subsembly.EBICS
Assembly: Subsembly.EBICS.Core.dll
Syntax
public class EbicsFileSpoolerJournalEntry : EbicsElement, IEbicsJsonConverter
Remarks

For every order file that is processed from the BOX_OUTBOX, a single EbicsFileSpoolerJournalEntry is created, and updated with new EbicsProtocolEntrys.

Properties

ErrorClass

The general error result returned from the Bank when uploading the order.

Declaration
public EbicsErrorClass ErrorClass { get; }
Property Value
Type Description
EbicsErrorClass
See Also

FileName

The file name of the processed file in the outbox.

Declaration
public string FileName { get; }
Property Value
Type Description
string

OrderID

The EBICS Order ID that was assigned by the Bank for this order.

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

The EBICS Order ID is needed to match EBICS protocol entries to the original order.

See Also

ProtocolEntries

Collection of EbicsProtocolEntry instances that have been collected for the order tracked by this journal entry.

Declaration
public EbicsProtocolEntry[] ProtocolEntries { get; }
Property Value
Type Description
EbicsProtocolEntry[]

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

After the initial file transfer this is always an empty array. Only after an EBICS protocol was downloaded, and some protocol entries of this download were assigned to this journal entry, then this is a nonempty array.

Timestamp

A UTC time stamp that is updated whenever this journal entry was changed, usually by adding a new EbicsProtocolEntry to it.

Declaration
public DateTime Timestamp { get; }
Property Value
Type Description
DateTime

Methods

BuildXml(XmlDocument, EbicsVersion)

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

CreateFileSpoolerJournalEntry(JsonObject)

Declaration
public static EbicsFileSpoolerJournalEntry CreateFileSpoolerJournalEntry(JsonObject jsonObject)
Parameters
Type Name Description
JsonObject jsonObject
Returns
Type Description
EbicsFileSpoolerJournalEntry

FromJson(JsonObject)

Initializes an EbicsFileSpoolerJournalEntry from its json representation. FromJson(JsonObject).

Declaration
public void FromJson(JsonObject jsonObject)
Parameters
Type Name Description
JsonObject jsonObject

ParseXml(XmlElement, EbicsVersion)

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

ToJson(JsonObject)

Converts an EbicsFileSpoolerJournalEntry to its json representation. ToJson(JsonObject).

Declaration
public JsonObject ToJson(JsonObject jsonObject)
Parameters
Type Name Description
JsonObject jsonObject
Returns
Type Description
JsonObject

Implements

Extension Methods