Class EbicsServiceMapRecord

Namespace

Subsembly.EBICS

Assembly

Subsembly.EBICS.Core.dll

Details of an entry of the EBICS order service mapping table.

public class EbicsServiceMapRecord

Inheritance

object

EbicsServiceMapRecord

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A EbicsServiceMapRecord contains the details of an EBICS order service with possible alternative variations, such as alternative Scopes, ServiceOptions, and ContainerTypes.

Constructors

EbicsServiceMapRecord(string, string, string, string, string, string, string, string, string)

public EbicsServiceMapRecord(string sOrderType, string sAdminOrderType, string sServiceName, string sServiceScopes, string sServiceOptions, string sMsgName, string sContainerTypes = null, string sMsgVersion = null, string sMsgVariant = null)

Parameters

sOrderType string

This is the classic H004 order type that is equivalent to the order service details of this EbicsServiceMapRecord. This must not be null.

sAdminOrderType string

The AdminOrderType that must be used with this service. This is usually either "BTU" or "BTD". This must not be null.

sServiceName string

The mandatory service name. Must not be null.

sServiceScopes string

List of alternative Service Scopes that all map to the same sOrderType. The list entries must be separated by a pipe '|' character. The list may contain empty entries. For example, the value "|GLB" indicates that the Service Scope may be empty or contain "GLB". The list may contain a single "*" as a wildcard character that matches any Scope content. If this parameter is null, then the scopes "" and "GLB" are added by default. When creating an EbicsService from this record, the first alternative will be used.

sServiceOptions string

List of alternative Service Options that all map to the same sOrderType. The list entries must be separated by a pipe '|' character. The list may contain empty entries. For example, the value "|VOO" indicates that the Service Option may be empty or contain "VOO". The list may contain a single "*" as a wildcard character that matches any ServiceOption content. This parameter may be null. If it is null, then it matches only a null or empty ServiceOption content. When creating an EbicsService from this record, the first alternative will be used.

sMsgName string

The mandatory name of the order data message. For ISO 20022 messages, this is something like "camt.052". For swift message this is something like "mt940". Or something completely proprietary. Must not be null.

sContainerTypes string

List of alternative Container Types that all map to the same sOrderType. The list entries must be separated by a pipe '|' character. The list may contain empty entries. For example, the value "XML|" indicates that the Container Type may contain "XML", or may be empty. The list may contain a single "*" as a wildcard character that matches any ContainerType content. This parameter may be null. If it is null, then it matches only a null or empty ContainerType content. When creating an EbicsService from this record, the first alternative will be used.

sMsgVersion string

The optional ISO 20022 message version to be used with the sMsgName. This must consist of exactly two digits, or be null.

sMsgVariant string

The optional ISO 20022 message variant to be used with the sMsgName. This must consist of exactly three digits, or be null.

Properties

AdminOrderType

The AdminOrderType that must be used for this service.

public string AdminOrderType { get; }

Property Value

string

ContainerType

Returns the first Container Type of this record entry.

public string ContainerType { get; }

Property Value

string

Remarks

If there are no alternatives, or the first alternative is empty, or the first alternative is a "*" wildcard, then null will be returned.

MsgName

public string MsgName { get; }

Property Value

string

MsgVariant

Optional ISO message variant.

public string MsgVariant { get; }

Property Value

string

Value must consist of exactly three digits, or must be null.

MsgVersion

Optional ISO message version.

public string MsgVersion { get; }

Property Value

string

Value must consist of exactly two digits, or must be null.

OrderType

public string OrderType { get; }

Property Value

string

ServiceName

public string ServiceName { get; }

Property Value

string

ServiceOption

Returns the first Service Option of this record entry.

public string ServiceOption { get; }

Property Value

string

Remarks

If there are no alternatives, or the first alternative is empty, or the first alternative is a "*" wildcard, then null will be returned.

ServiceScope

Returns the first Service Scope of this record entry.

public string ServiceScope { get; }

Property Value

string

Remarks

If there are no alternatives, or the first alternative is empty, or the first alternative is a "*" wildcard, then null will be returned.