Class EbicsOrderProtocol

Base class for EBICS protocol download via EbicsOrderHAC or EbicsOrderPTK.

Inheritance
System.Object
EbicsOrder
EbicsOrderProtocol
EbicsOrderHAC
EbicsOrderPTK
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)
System.Object.ToString()
Namespace: Subsembly.EBICS
Assembly: Subsembly.EBICS.Core.dll
Syntax
public class EbicsOrderProtocol : EbicsOrder

Constructors

EbicsOrderProtocol(String, DateTime, DateTime)

Declaration
public EbicsOrderProtocol(string sOrderType, DateTime tFrom, DateTime tTo)
Parameters
Type Name Description
System.String sOrderType
System.DateTime tFrom
System.DateTime tTo

Properties

ProtocolEntries

Provides the received protocol parsed into a collection of EbicsProtocolEntries.

Declaration
public EbicsProtocolEntries ProtocolEntries { get; protected set; }
Property Value
Type Description
EbicsProtocolEntries
Remarks

This property is null until a protocol was successfully downloaded and processed.

Methods

CreateOrder(String, DateTime)

Declaration
public static EbicsOrderProtocol CreateOrder(string sOrderType = null, DateTime tFromDate = default(DateTime))
Parameters
Type Name Description
System.String sOrderType

The Order Type that shall be used by the Order for downlading the protocol data. This is used to select the derived EbicsOrderProtocol instance. If this is null, then the default "HAC" order type will be used.
System.DateTime tFromDate

The starting date for downloading the protocol data. This can be either DateTime.MinValue, in order to get and consume the latest data, or s specific past date.
Returns
Type Description
EbicsOrderProtocol

Returns an appropriately derived EbicsOrderProtocol instance for downloading protocol data with the given order type.
Remarks

Currently the following values for sOrderType will create instances of these classes.

Order TypesInstantiated Class
HACEbicsOrderHAC
PTKEbicsOrderPTK

Exceptions
Type Condition
System.ArgumentException

The parameter sOrderType was not a valid order type string.
System.NotSupportedException

The requested sOrderType is not a supported order type.

GetOrderTypes()

Gets an array of order types that are supported by CreateOrder(String, DateTime).

Declaration
public static string[] GetOrderTypes()
Returns
Type Description
System.String[]