Class EbicsUserPermission

Namespace
Subsembly.EBICS
Assembly
Subsembly.EBICS.Core.dll

Holds the data of a single Permission element, as it is found in a HKDResponseOrderData or HTDResponseOrderData XML element.

public class EbicsUserPermission : EbicsElement
Inheritance
EbicsUserPermission
Inherited Members

Remarks

For EBICS 2.x a single Permission element may apply to a list of OrderTypes. Starting with EBICS 3.0, a single Permission element refers to exactly one order type given by its AdminOrderType and Service element.

Constructors

EbicsUserPermission() 

public EbicsUserPermission()

EbicsUserPermission(string, EbicsService)

Creates an EBICS 3.x style EbicsUserPermission with the given admin order type and service.

public EbicsUserPermission(string sAdminOrderType, EbicsService aService)

Parameters

sAdminOrderType string
aService EbicsService

Optional EbicsService that may be null if the sAdminOrderType is not "BTU" or "BTD".

Exceptions

ArgumentNullException
ArgumentException

EbicsUserPermission(string[])

Creates an EBICS 2.x style EbicsUserPermission with the given order types.

public EbicsUserPermission(string[] vsOrderTypes)

Parameters

vsOrderTypes string[]

Exceptions

ArgumentNullException
ArgumentException

Properties

AccountID

Optional account ID.

public string AccountID { get; set; }

Property Value

string

Remarks

If no AccountID was provided, then this permission applied to all accounts of this user.

AdminOrderType

For EBICS 3.0 this is the AdminOrderType element for which this permission applies. For EBICS 2.x this is not used.

public string AdminOrderType { get; set; }

Property Value

string

Remarks

This must be evaluated together with the Service element.

AuthorisationLevel

The value of the optional AuthorisationLevel attribute.

public EbicsAuthorisationLevel AuthorisationLevel { get; set; }

Property Value

EbicsAuthorisationLevel

Remarks

If this is Null then there is no AuthorisationLevel attribute.

AuthorisationLevelString

Optional AuthorisationLevel attribute.

public string AuthorisationLevelString { get; set; }

Property Value

string

Remarks

This must be one of "E", "A", "B", or "T".

MaxAmount

Optional maximum order amount.

public decimal MaxAmount { get; set; }

Property Value

decimal

MaxAmountCurrency 

public string MaxAmountCurrency { get; set; }

Property Value

string

OrderTypes

For EBICS 2.x this is a mandatory array of order type codes for which this permission applies. applies.

public string[] OrderTypes { get; set; }

Property Value

string[]

Remarks

Reading this property in the context of EBICS 3.0 is deprecated. Instead the method GetOrderTypes(EbicsContact) shall be used to obtain a mapping of the Service element.

Starting with EBICS 3.0 this property no longer exists. When reading this property for an EBICS 3.0 UserPermission element, an attempt is made to map the Service and AdminOrderType to the corresponding old style order type and return an array with a single OrderType string element. If the EBICS 3.0 service could not be resolved, then null is returned.

Service

For EBICS 3.0 this is the Service element for which this permission applies. For EBICS 2.x this is not used.

public EbicsService Service { get; set; }

Property Value

EbicsService

Methods

BuildXml(XmlDocument, EbicsVersion) 

public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument
nVersion EbicsVersion

Returns

XmlElement

GetOrderTypes(EbicsContact) 

public string[] GetOrderTypes(EbicsContact aContact)

Parameters

aContact EbicsContact

Returns

string[]

ParseXml(XmlElement, EbicsVersion) 

public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)

Parameters

xmlElement XmlElement
nVersion EbicsVersion