Class SepaEbicsPartyIdentificationExtensions

Namespace

Subsembly.Sepa

Assembly

Subsembly.Sepa.dll

Extensions for EBICS specific usage of the SepaPartyIdentification element.

public static class SepaEbicsPartyIdentificationExtensions

Inheritance

object

SepaEbicsPartyIdentificationExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetEbicsPartnerId(SepaPartyIdentification)

Get the EBICS Partner ID of a party.

public static string GetEbicsPartnerId(this SepaPartyIdentification aPty)

Parameters

aPty SepaPartyIdentification

Returns

string

If a SepaOtherId with Issuer EBICS is found, then its Identification value is returned. Otherwise null is returned.

Remarks

The EBICS Partner ID is only used when the party identification is used for a MessageRecipient element.

Exceptions

ArgumentNullException

GetEbicsServiceCenterId(SepaPartyIdentification)

Get the EBICS Service Center ID of a party.

public static string GetEbicsServiceCenterId(this SepaPartyIdentification aPty)

Parameters

aPty SepaPartyIdentification

Returns

string

If a SepaOtherId with Issuer DK, and SchemeNameProprietary SRZ is found, then its Identification value is returned. Otherwise null is returned.

The returned string is trimmed from leading and trailing white-space.

Remarks

The EBICS Service Center ID is only used on the InitiatingParty in a SRZ message container.

Exceptions

ArgumentNullException

SetEbicsHostId(SepaPartyIdentification, string)

Set the EBICS Host ID for a HAC protocol InitiatingParty.

public static void SetEbicsHostId(this SepaPartyIdentification aPty, string sHostId)

Parameters

aPty SepaPartyIdentification

sHostId string

The EBICS Host ID to set, or null to clear the EBICS Host ID.

Remarks

Setting the EBICS Host ID with a non-null value will implicitly set the PartyChoice to OrgId.

Exceptions

ArgumentNullException

ArgumentException

The parameter sHostId does not contain a valid Identification value.

SetEbicsPartnerId(SepaPartyIdentification, string)

Set the EBICS Partner ID of a party.

public static void SetEbicsPartnerId(this SepaPartyIdentification aPty, string sPartnerId)

Parameters

aPty SepaPartyIdentification

sPartnerId string

The EBICS Partner ID to set, or null to clear the EBICS Partner ID.

Remarks

Setting the EBICS Partner ID with a non-null value will implicitly set the PartyChoice to OrgId.

Exceptions

ArgumentNullException

ArgumentException

The parameter sPartnerId does not contain a valid Identification value.

SetEbicsProtocolEntry(SepaPartyIdentification, string, string)

Set the EBICS Protocol Entry for a HAC protocol.

public static void SetEbicsProtocolEntry(this SepaPartyIdentification aPty, string sTag, string sValue)

Parameters

aPty SepaPartyIdentification

sTag string

The tag for the EBICS Protocol Entry. This must not be null or an empty string.

sValue string

The value to set for the sTag. If this is null, then the Protocol Entry with the sTag will be removed.

Remarks

Setting a EBICS Protocol Entry with a non-null value will implicitly set the PartyChoice to OrgId.

Exceptions

ArgumentNullException

SetEbicsServiceCenterId(SepaPartyIdentification, string)

Set the EBICS Service Center ID of a party.

public static void SetEbicsServiceCenterId(this SepaPartyIdentification aPty, string sServiceCenterId)

Parameters

aPty SepaPartyIdentification

sServiceCenterId string

The EBICS Service Center ID to set, or null to clear the EBICS Service Center ID.

Remarks

Setting the EBICS Service Center ID with a non-null value will implicitly set the PartyChoice to OrgId.

Exceptions

ArgumentNullException

ArgumentException

The parameter sServiceCenterId does not contain a valid Identification value.