Class EbicsAuthOrderInfo

Holds an EBICS OrderInfo XML element as used in a EbicsHTDResponseOrderData instance.

Inheritance
System.Object
EbicsElement
EbicsAuthOrderInfo
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 EbicsAuthOrderInfo : EbicsElement

Properties

AdminOrderType

The EBICS 3.0 AdminOrderType.

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

Description

Human readable description of this OrderType.

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

This child element is actually a required child element.

NumSigRequired

Number of EU signatures required for this OrderType.

Declaration
public int NumSigRequired { get; set; }
Property Value
Type Description
System.Int32
Remarks

This child element is optional. It may be provided with the value zero in order to indicate that the number of signatures is not explicitly specified.

OrderFormat

The data format used by this OrderType.

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

This is some token string that is not specified by EBICS and therefore rather useless. This child element is optional. No attempt is made to derive this from Service, if it isn't set.

OrderType

The three letter order type that this OrderInfo is about. Consider calling GetOrderType(EbicsContact) instead of reading this property.

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

Before EBICS 3.0 this was a mandatory child element of the OrderInfo element and is usually the primary key that is searched in a collection of order infos. Starting with EBICS 3.0 this property no longer exists. When reading this property an attempt is made to map the Service and AdminOrderType to the corresponding order type.

See Also

Service

The EBICS 3.0 Service.

Declaration
public EbicsService Service { get; set; }
Property Value
Type Description
EbicsService
Remarks

The Service element was introduced with EBICS 3.0 in order to replace the OrderType.

TransferType

The transfer type, either Upload or Download.

Declaration
public EbicsTransferType TransferType { get; set; }
Property Value
Type Description
EbicsTransferType
Remarks

Before EBICS 3.0 this was a mandatory child element of the OrderInfo element. Starting with EBICS 3.0 this property no longer exists. When reading this property an attempt is made to derive this from the Service.

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

GetOrderType(EbicsContact)

The three letter order type that this OrderInfo is about.

Declaration
public string GetOrderType(EbicsContact aContact)
Parameters
Type Name Description
EbicsContact aContact

The EbicsContact to which this EbicsAuthOrderInfo belongs to. This is needed to properly derive the order type from the Service when needed. If this is null, then the Default mapping is used.
Returns
Type Description
System.String
Remarks

Before EBICS 3.0 this was a mandatory child element of the OrderInfo element and is usually the primary key that is searched in a collection of order infos. Starting with EBICS 3.0 this property no longer exists. When reading this property an attempt is made to map the Service and AdminOrderType to the corresponding order type.

ParseXml(XmlElement, EbicsVersion)

Declaration
public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement
EbicsVersion nVersion
Overrides