Class EbicsAuthOrderInfo

Namespace

Subsembly.EBICS

Assembly

Subsembly.EBICS.Core.dll

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

public class EbicsAuthOrderInfo : EbicsElement

Inheritance

object

EbicsElement

EbicsAuthOrderInfo

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)

object.ToString()

Properties

AdminOrderType

The EBICS 3.0 AdminOrderType.

public string AdminOrderType { get; set; }

Property Value

string

Description

Human readable description of this OrderType.

public string Description { get; set; }

Property Value

string

Remarks

This child element is actually a required child element.

NumSigRequired

Number of EU signatures required for this OrderType.

public int NumSigRequired { get; set; }

Property Value

int

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.

public string OrderFormat { get; set; }

Property Value

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.

public string OrderType { get; set; }

Property Value

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

GetOrderType(EbicsContact)

Service

The EBICS 3.0 Service.

public EbicsService Service { get; set; }

Property Value

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.

public EbicsTransferType TransferType { get; set; }

Property Value

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)

public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument

nVersion EbicsVersion

Returns

XmlElement

GetOrderType(EbicsContact)

The three letter order type that this OrderInfo is about.

public string GetOrderType(EbicsContact aContact)

Parameters

aContact EbicsContact

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

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)

public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)

Parameters

xmlElement XmlElement

nVersion EbicsVersion