Class EbicsOrderInfo

Namespace

Subsembly.EBICS

Assembly

Subsembly.EBICS.Core.dll

HVTOrderInfo Type.

public class EbicsOrderInfo : EbicsElement

Inheritance

object

EbicsElement

EbicsOrderInfo

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()

Extension Methods

EbicsVopOrderInfo.GetVopCloseMatchName(EbicsOrderInfo)

EbicsVopOrderInfo.GetVopStatusCode(EbicsOrderInfo)

EbicsVopOrderInfo.SetVopStatusCode(EbicsOrderInfo, VopStatusCode, string)

Remarks

The EbicsHVTResponseOrderData holds a collection of order infos in its OrderInfos property.

Constructors

EbicsOrderInfo()

public EbicsOrderInfo()

Properties

AccountInfos

Collection of all AccountInfo elements that were received.

public EbicsAccountInfos AccountInfos { get; }

Property Value

EbicsAccountInfos

Amount

The amount of this order.

public decimal Amount { get; set; }

Property Value

decimal

Currency

The optional currency of the payments in this order.

public string Currency { get; set; }

Property Value

string

Descriptions

Up to four description strings which may include Purpose, Details or Comments.

public string[] Descriptions { get; }

Property Value

string[]

ExecutionDate

Optional execution date of this order.

public DateTime ExecutionDate { get; set; }

Property Value

DateTime

The value of this property is DateTime.MinValue if no execution date has been provided.

IsCredit

Optional isCredit flag for the Amount.

public bool? IsCredit { get; set; }

Property Value

bool?

OrderFormat

The data format used by this order.

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.

TypedDescriptions

public EbicsOrderInfoDescription[] TypedDescriptions { get; }

Property Value

EbicsOrderInfoDescription[]

Methods

AddDescription(EbicsOrderInfoDescription)

public void AddDescription(EbicsOrderInfoDescription tDescription)

Parameters

tDescription EbicsOrderInfoDescription

AddDescription(string, string)

public void AddDescription(string sType, string sDescription)

Parameters

sType string

sDescription string

BuildXml(XmlDocument, EbicsVersion)

public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument

nVersion EbicsVersion

Returns

XmlElement

Remarks

This is not supported and therefore always throws a NotSupportedException.

Clear()

public void Clear()

ClearDescriptions()

public void ClearDescriptions()

GetDescriptions(string)

Returns the Description entries of the given Type.

public string[] GetDescriptions(string sType)

Parameters

sType string

The required value of the Type attribute of the Description element. Only the content of the Description elements which have this Type attribute is returned. This must not be null or an empty string.

Returns

string[]

Returns an array with one entry for each matching Description element. If none of the Description elements are matching, then an empty array is returned. The return value is never null.

Exceptions

ArgumentNullException

ParseXml(XmlElement, EbicsVersion)

public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)

Parameters

xmlElement XmlElement

nVersion EbicsVersion