Class EbicsOrderProtocol
Base class for EBICS protocol download via EbicsOrderHAC or EbicsOrderPTK.
public class EbicsOrderProtocol : EbicsOrder
- Inheritance
-
EbicsOrderProtocol
- Derived
- Inherited Members
Constructors
EbicsOrderProtocol(string, DateTime, DateTime)
public EbicsOrderProtocol(string sOrderType, DateTime tFrom, DateTime tTo)
Parameters
Properties
ProtocolEntries
Provides the received protocol parsed into a collection of EbicsProtocolEntries.
public EbicsProtocolEntries ProtocolEntries { get; protected set; }
Property Value
Remarks
This property is null
until a protocol was successfully downloaded and
processed.
Methods
CreateOrder(string, DateTime)
public static EbicsOrderProtocol CreateOrder(string sOrderType = null, DateTime tFromDate = default)
Parameters
sOrderType
stringThe 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.tFromDate
DateTimeThe 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
- 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
- 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).
public static string[] GetOrderTypes()
Returns
- string[]