Class EbicsOrderProtocol

Base class for EBICS protocol download via EbicsOrderHAC or EbicsOrderPTK.

Inheritance

object

EbicsOrder

EbicsOrderProtocol

EbicsOrderHAC

EbicsOrderPTK

Inherited Members

EbicsOrder.CreateNextOrderID()

EbicsOrder.Service

EbicsOrder.OrderType

EbicsOrder.AdminOrderType

EbicsOrder.Upload

EbicsOrder.TransferType

EbicsOrder.OrderID

EbicsOrder.OrderAttribute

EbicsOrder.OrderParams

EbicsOrder.AdditionalOrderInfo

EbicsOrder.AuthorisationLevel

EbicsOrder.OrderSignatures

EbicsOrder.OrderData

EbicsOrder.TechnicalReturnCode

EbicsOrder.BusinessReturnCode

EbicsOrder.Success

EbicsOrder.NoData

EbicsOrder.SuccessOrNoData

EbicsOrder.ErrorClass

EbicsOrder.Transaction

EbicsOrder.TransactionTraceText

EbicsOrder.TransactionID

EbicsOrder.TransactionState

EbicsOrder.Sign(EbicsContact, IEbicsSecurityMedium)

EbicsOrder.ProcessResponseOrderData(EbicsVersion)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

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
string	sOrderType
DateTime	tFrom
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)

Parameters

Type	Name	Description
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.
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 Types	Instantiated Class
HAC	EbicsOrderHAC
PTK	EbicsOrderPTK

Exceptions

Type	Condition
ArgumentException	The parameter sOrderType was not a valid order type string.
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
string[]