Class EbicsServiceMap

Catalog of well known EBICS services. This is required for conversion between an EBICS Service element and an EBICS OrderType.

Inheritance

System.Object

EbicsServiceMap

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 EbicsServiceMap

Constructors

EbicsServiceMap()

Creates an empty EbicsServiceMap.

Declaration

public EbicsServiceMap()

EbicsServiceMap(EbicsServiceMapRecord[])

Creates a EbicsServiceMap that initially contains the given records.

Declaration

public EbicsServiceMap(EbicsServiceMapRecord[] vRecords)

Parameters

Type	Name	Description
EbicsServiceMapRecord[]	vRecords

Exceptions

Type	Condition
System.ArgumentNullException
System.ArgumentException	The given array of records did contain a duplicate entry for the same OrderType or, one of the records in the array was not correctly initialized.

Properties

Default

Declaration

public static EbicsServiceMap Default { get; }

Property Value

Type	Description
EbicsServiceMap

Methods

AddRecord(EbicsServiceMapRecord, Boolean)

Add or replace a EbicsServiceMapRecord in this map.

Declaration

public bool AddRecord(EbicsServiceMapRecord aRecord, bool fReplace = false)

Parameters

Type	Name	Description
EbicsServiceMapRecord	aRecord
System.Boolean	fReplace	If true, then an existing entry with the same OrderType will be replaced with the given entry. If false, then an existing entry will not be replaced and the given record will not be added in that case.

Returns

Type	Description
System.Boolean	If the given record was actually added as a new entry, then true is returned. If the entry already exists, then false is returned, even when it was replaced.

Exceptions

Type	Condition
System.ArgumentNullException
System.ArgumentException

CreateService(String)

Declaration

public EbicsService CreateService(string sOrderType)

Parameters

Type	Name	Description
System.String	sOrderType	The classic order type for which a corresponding EBICS 3.0 Service shall be created. May be null.

Returns

Type	Description
EbicsService	If the given sOrderType is null, or cannot be mapped to a Service, then null will be returned. Otherwise a new EbicsService instance that matches the classic order type, will be returned.

Exceptions

Type	Condition
System.ArgumentException	The parameter sOrderType was not a valid order type specification.

CreateServiceMap(String)

Creates a new instance of a EbicsServiceMap, initialized with the well known entries for a given country.

Declaration

public static EbicsServiceMap CreateServiceMap(string sCountryCode)

Parameters

Type	Name	Description
System.String	sCountryCode	The ISO country code of the country to get a EbicsServiceMap for. Must not be null.

Returns

Type	Description
EbicsServiceMap	If there is a well known EbicsServiceMap for the requested country, then it is returned. If no service map is known for that country, then null is returned.

Remarks

Currently there are well known service maps for Germany (DE), Switzerland (CH), and Austria (AT). For any other country codes the value null will be returned.

Exceptions

Type	Condition
System.ArgumentNullException
System.ArgumentException	The parameter sCountryCode was not a valid ISO country code.

FindByOrderType(String)

Tries to find a service mapping for a given order type.

Declaration

public EbicsServiceMapRecord FindByOrderType(string sOrderType)

Parameters

Type	Name	Description
System.String	sOrderType

Returns

Type	Description
EbicsServiceMapRecord	If a mapping was found, then it is returned. If there is no mapping known for the given order type, then null is returned.

Exceptions

Type	Condition
System.ArgumentNullException	The parameter sOrderType was null.
System.ArgumentException	The parameter sOrderType was not a valid order type specification.

FindByService(EbicsService)

Tries to find the EbicsServiceMapRecord for a EbicsService instance.

Declaration

public EbicsServiceMapRecord FindByService(EbicsService aService)

Parameters

Type	Name	Description
EbicsService	aService	The EbicsService element for which to find a record entry.

Returns

Type	Description
EbicsServiceMapRecord	If a mapping was found, then it is returned. If there is no mapping known for the given service, then null is returned.

Exceptions

Type	Condition
System.ArgumentNullException	The parameter aService was null.

GetOrderType(EbicsService)

Tries to get the order type for a BTD or BTU service.

Declaration

public string GetOrderType(EbicsService aService)

Parameters

Type	Name	Description
EbicsService	aService	The EbicsService for which to determine the order type. This may be null, in which case null will be returned.

Returns

Type	Description
System.String	Returns the classic order type that matches the given service, or null, if the given service cannot be resolved to a known classic order type.

Exceptions

Type	Condition
System.ArgumentNullException	The parameter aService was null.

GetOrderType(String, EbicsService)

Tries to get the order type for an AdminOrderType and Service.

Declaration

public string GetOrderType(string sAdminOrderType, EbicsService aService)

Parameters

Type	Name	Description
System.String	sAdminOrderType	The AdminOrderType associated with the optional aService. This must not be null. This is usually BTD or BTU, but may be any other order type.
EbicsService	aService	If the sAdminOrderType is BTD or BTU, then the Service element must be provided in order to derive the classic OrderType.

Returns

Type	Description
System.String