Class EbicsFileTransferResult

Contains all information about the result of a single EbicsFileTransfer.

Inheritance
System.Object
EbicsElement
EbicsFileTransferResult
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Subsembly.EBICS
Assembly: Subsembly.EBICS.Core.dll
Syntax
public class EbicsFileTransferResult : EbicsElement, IEbicsJsonConverter
Remarks

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

Constructors

EbicsFileTransferResult()

Declaration
public EbicsFileTransferResult()

EbicsFileTransferResult(EbicsErrorClass, EbicsOrder)

Declaration
public EbicsFileTransferResult(EbicsErrorClass nErrorClass, EbicsOrder aOrder)
Parameters
Type Name Description
EbicsErrorClass nErrorClass
EbicsOrder aOrder

Properties

BusinessReturnCode

See EbicsOrder.BusinessReturnCode.

Declaration
public EbicsReturnCode BusinessReturnCode { get; }
Property Value
Type Description
EbicsReturnCode

ErrorClass

See EbicsContact.Send(EbicsOrder, IEbicsSecurityMedium, IEbicsTransport)

Declaration
public EbicsErrorClass ErrorClass { get; }
Property Value
Type Description
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.

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

OrderID

See EbicsOrder.OrderID.

Declaration
public string OrderID { get; }
Property Value
Type Description
System.String

OrderType

See EbicsOrder.OrderType.

Declaration
public string OrderType { get; }
Property Value
Type Description
System.String

Success

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

Declaration
public bool Success { get; }
Property Value
Type Description
System.Boolean
See Also

SuccessOrNoData

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

Declaration
public bool SuccessOrNoData { get; }
Property Value
Type Description
System.Boolean
See Also

TechnicalReturnCode

See EbicsOrder.TechnicalReturnCode.

Declaration
public EbicsReturnCode TechnicalReturnCode { get; }
Property Value
Type Description
EbicsReturnCode

Timestamp

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

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

TransactionID

See EbicsOrder.TransactionID.

Declaration
public string TransactionID { get; }
Property Value
Type Description
System.String

TransactionTraceText

See EbicsOrder.TransactionTraceText.

Declaration
public string TransactionTraceText { get; }
Property Value
Type Description
System.String
Remarks

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

Methods

BuildXml(XmlDocument, EbicsVersion)

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

Clear()

Declaration
public void Clear()

CreateFileTransferResult(JsonObject)

Declaration
public static EbicsFileTransferResult CreateFileTransferResult(JsonObject jsonObject)
Parameters
Type Name Description
JsonObject jsonObject
Returns
Type Description
EbicsFileTransferResult

FromJson(JsonObject)

Initializes an EbicsFileTransferResult 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
System.Xml.XmlElement xmlElement
EbicsVersion nVersion
Overrides

ToJson(JsonObject)

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

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

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Implements

Extension Methods