Class EbicsFileSpoolerJournalEntry

Namespace

Subsembly.EBICS

Assembly

Subsembly.EBICS.Core.dll

Represents a single entry in the EbicsFileSpoolerJournal.

public class EbicsFileSpoolerJournalEntry : EbicsElement, IEbicsJsonConverter

Inheritance

object

EbicsElement

EbicsFileSpoolerJournalEntry

Implements

IEbicsJsonConverter

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()

Extension Methods

EbicsJsonConverterExtensions.ToJson(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.

public EbicsErrorClass ErrorClass { get; }

Property Value

EbicsErrorClass

See Also

Send(EbicsOrder, IEbicsSecurityMedium, IEbicsTransport)

FileName

The file name of the processed file in the outbox.

public string FileName { get; }

Property Value

string

OrderID

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

public string OrderID { get; }

Property Value

string

Remarks

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

See Also

OrderID

ProtocolEntries

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

public EbicsProtocolEntry[] ProtocolEntries { get; }

Property Value

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.

public DateTime Timestamp { get; }

Property Value

DateTime

Methods

BuildXml(XmlDocument, EbicsVersion)

public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument

nVersion EbicsVersion

Returns

XmlElement

CreateFileSpoolerJournalEntry(JsonObject)

public static EbicsFileSpoolerJournalEntry CreateFileSpoolerJournalEntry(JsonObject jsonObject)

Parameters

jsonObject JsonObject

Returns

EbicsFileSpoolerJournalEntry

FromJson(JsonObject)

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

public void FromJson(JsonObject jsonObject)

Parameters

jsonObject JsonObject

ParseXml(XmlElement, EbicsVersion)

public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)

Parameters

xmlElement XmlElement

nVersion EbicsVersion

ToJson(JsonObject)

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

public JsonObject ToJson(JsonObject jsonObject)

Parameters

jsonObject JsonObject

Returns

JsonObject