Class EbicsProtocolEntry

Namespace: Subsembly.EBICS

Assembly: Subsembly.EBICS.Core.dll

Stores the details of a single customer protocol entry (PTK)

public class EbicsProtocolEntry : EbicsElement, IEbicsJsonConverter

Inheritance: object

EbicsElement

EbicsProtocolEntry

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

The following example illustrates how the various properties are set from a given protocol text. Let's assume the following protocol text:

26.11.09 11:48:14     Datei zur Bank uebertragen                        
         Hostname   : CBKEBIX1                                          
         Auftrag    : Inlandszahlungsverkehr                    IZV DQOD
         Teilnehmer : L4190030 SELLEAND Andreas Selle                   
         Ergebnis   : Uebertragung in Ordnung [01]                      
                      Datenuebertragung verschluesselt [04]             
                      Datenuebertragung komprimiert [05]

The individual properties will be set with the following values.

TimeStamp	2009-11-26 11:48:14
ActionText	Datei zur Bank uebertragen
ActionCode	-1 Protocol entry sample contains no action ID in square brackets such as e.g. [21].
OrderText	Inlandszahlungsverkehr
OrderType	IZV
OrderID	DQOD
ResultText	Uebertragung in Ordnung
ResultCode	1
Text	The complete protocol entry text as shown above.
DisplayFile	Only set if a display file was included (not in the example above)

Properties

ActionCode

The value of the action code found in square brackets.

public int ActionCode { get; set; }

Property Value

int: If no action code is included in the protocol entry text, then this is -1. Otherwise the action code can range from 0 to 99.

Remarks

This only exists for a PTK protocol entry.

ActionDescription

Provides a human readable decsription for the ActionText.

public string ActionDescription { get; }

Property Value

string

ActionText

public string ActionText { get; set; }

Property Value

string

Remarks

For a HAC protocol entry this is the value from the OrgnlPmtInfId element. This should be one of the action type texts, such as "FILE_UPLOAD", or "ORDER_HAC_FINAL_POS".

See Also: ActionType

ActionDescription

ActionType

This is derived from the ActionText.

public EbicsProtocolActionType ActionType { get; set; }

Property Value

EbicsProtocolActionType

DisplayFile

Optional display file text.

public string DisplayFile { get; set; }

Property Value

string

Remarks

If a display file or additional information text was included in the protocol entry, then it is stored in this property.

ExternalReasonCode

The External Reason Code from a HAC protocol entry.

public string ExternalReasonCode { get; set; }

Property Value

string

Remarks

This is null for a PTK protocol entry.

ExternalReasonCodeDescription

Provides a human readable description for the ExternalReasonCode.

public string ExternalReasonCodeDescription { get; }

Property Value

string

Remarks

If there is no ExternalReasonCode, then this property is null. If there is no known description for the ExternalReasonCode, then a placeholder text that contains the original ExternalReasonCode is provided. In any other case a descriptive, readable text for the ExternalReasonCode is provided.

OrderID

public string OrderID { get; set; }

Property Value

string

OrderIDRef

If this was an order that referred to another order, e.g. a VEU signature for another order, then this contains the OrderID of the other, original order.

public string OrderIDRef { get; set; }

Property Value

string

OrderText

public string OrderText { get; set; }

Property Value

string

Remarks

This only exists for a PTK protocol entry.

OrderType

public string OrderType { get; set; }

Property Value

string

ResultCode

The value of the result code found in square brackets.

public int ResultCode { get; set; }

Property Value

int: If no result code is included in the protocol entry text, then this is -1. Otherwise the result code can range from 0 to 99.

Remarks

This only exists for a PTK protocol entry.

ResultText

public string ResultText { get; set; }

Property Value

string

Remarks

This only exists for a PTK protocol entry.

Text

The complete, raw text of this protocol entry.

public string Text { get; set; }

Property Value

string

Remarks

This only exists for a PTK protocol entry, for a HAC protocol entry this is null.

TimeStamp

public DateTime TimeStamp { get; set; }

Property Value

DateTime

Methods

BuildXml(XmlDocument, EbicsVersion)

public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument
nVersion EbicsVersion

Returns

XmlElement

Clear()

public void Clear()

CreateProtocolEntry(JsonObject)

public static EbicsProtocolEntry CreateProtocolEntry(JsonObject jsonObject)

Parameters

jsonObject JsonObject

Returns

EbicsProtocolEntry

FromJson(JsonObject)

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

public JsonObject ToJson(JsonObject jsonObject)

Parameters

jsonObject JsonObject

Returns

JsonObject

ToString()

public override string ToString()

Returns

string