Class EbicsFileTransferResult

Namespace

Subsembly.EBICS

Assembly

Subsembly.EBICS.Core.dll

Contains all information about the result of a single EbicsFileTransfer.

public class EbicsFileTransferResult : EbicsElement, IEbicsJsonConverter

Inheritance

object

EbicsElement

EbicsFileTransferResult

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)

Extension Methods

EbicsJsonConverterExtensions.ToJson(IEbicsJsonConverter)

Remarks

Instances of this class are used in order to track the result of EBICS file spooler uploads and downloads.

Constructors

EbicsFileTransferResult()

public EbicsFileTransferResult()

EbicsFileTransferResult(EbicsErrorClass, EbicsOrder)

public EbicsFileTransferResult(EbicsErrorClass nErrorClass, EbicsOrder aOrder)

Parameters

nErrorClass EbicsErrorClass

aOrder EbicsOrder

Properties

BusinessReturnCode

See EbicsOrder.BusinessReturnCode.

public EbicsReturnCode BusinessReturnCode { get; }

Property Value

EbicsReturnCode

ErrorClass

See EbicsContact.Send(EbicsOrder, IEbicsSecurityMedium, IEbicsTransport)

public EbicsErrorClass ErrorClass { get; }

Property Value

EbicsErrorClass

FileName

If set, this contains the name of the local file system file that was uploaded or downloaded. This does not include any path information.

public string FileName { get; }

Property Value

string

OrderID

See EbicsOrder.OrderID.

public string OrderID { get; }

Property Value

string

OrderType

See EbicsOrder.OrderType.

public string OrderType { get; }

Property Value

string

Success

True if, and only if, the technical and the business return code indicate Success.

public bool Success { get; }

Property Value

bool

See Also

SuccessOrNoData

SuccessOrNoData

True if the return code indicates Success or if the business return code is EBICS_NO_DOWNLOAD_DATA_AVAILABLE.

public bool SuccessOrNoData { get; }

Property Value

bool

See Also

Success

TechnicalReturnCode

See EbicsOrder.TechnicalReturnCode.

public EbicsReturnCode TechnicalReturnCode { get; }

Property Value

EbicsReturnCode

Timestamp

A UTC time stamp that was taken when this object was initially created.

public DateTime Timestamp { get; }

Property Value

DateTime

TransactionID

See EbicsOrder.TransactionID.

public string TransactionID { get; }

Property Value

string

TransactionTraceText

See EbicsOrder.TransactionTraceText.

public string TransactionTraceText { get; }

Property Value

string

Remarks

This property is not persisted when saving an instance of this class.

Methods

BuildXml(XmlDocument, EbicsVersion)

public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument

nVersion EbicsVersion

Returns

XmlElement

Clear()

public void Clear()

CreateFileTransferResult(JsonObject)

public static EbicsFileTransferResult CreateFileTransferResult(JsonObject jsonObject)

Parameters

jsonObject JsonObject

Returns

EbicsFileTransferResult

FromJson(JsonObject)

Initializes an EbicsFileTransferResult 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 EbicsFileTransferResult to its json representation. ToJson(JsonObject).

public JsonObject ToJson(JsonObject jsonObject)

Parameters

jsonObject JsonObject

Returns

JsonObject

ToString()

public override string ToString()

Returns

string