Struct SepaCreditorID

Helper class for working with a SEPA Creditor Identifier.

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Subsembly.Sepa

Assembly: Subsembly.Sepa.dll

Syntax

public struct SepaCreditorID

Constructors

SepaCreditorID(string)

Declaration

public SepaCreditorID(string sCreditorID)

Parameters

Type	Name	Description
string	sCreditorID	The creditor ID. If this is null or an empty string, then this will be a Null creditor ID. Use Capture(string) in order to pre-process a user entered creditor ID.

Exceptions

Type	Condition
ArgumentException	The given creditor ID string was not a syntactically correct creditor ID (i.e. IsValid(string) returns false on it.

Fields

MAXLENGTH

The maximum length of any creditor identifier.

Declaration

public const int MAXLENGTH = 35

Field Value

Type	Description
int

MINLENGTH

The minimum length of any creditor identifier.

Declaration

public const int MINLENGTH = 8

Field Value

Type	Description
int

Null

Represents an unset SepaCreditorID instance.

Declaration

public static readonly SepaCreditorID Null

Field Value

Type	Description
SepaCreditorID

Properties

CountryCode

Provides the country code portion of this SEPA Creditor Identifier.

Declaration

public string CountryCode { get; }

Property Value

Type	Description
string

CreditorID

Provides the wrapped SEPA Creditor Identifier.

Declaration

public string CreditorID { get; }

Property Value

Type	Description
string

IsNull

Indicates whether this SEPA Creditor Identifier is Null.

Declaration

public bool IsNull { get; }

Property Value

Type	Description
bool

Methods

Capture(string)

Captures a creditor ID entered by the user, removing whitespace and converting lower case to upper case.

Declaration

public static string Capture(string sCreditorId)

Parameters

Type	Name	Description
string	sCreditorId

Returns

Type	Description
string	If the parameter sCreditorId was null or an empty string, then the return value will be null.

Remarks

Any non alphanumeric characters, such as whitespace or symbols, are removed from the captured creditor ID.

Any lower case letters are converted into upper case letters.

IsValid(string)

Equals(object)

Compares the SEPA Creditor Identifier for equivalence.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	Right hand side to compare to.

Returns

Type	Description
bool	True if both are essentially the same SEPA Creditor Identifier.

Overrides

ValueType.Equals(object)

Format(string)

Nicely formats the given creditor ID input into groups.

Declaration

public static string Format(string sCreditorId)

Parameters

Type	Name	Description
string	sCreditorId

Returns

Type	Description
string

GetCountryCode(string)

Returns the country code portion of the given SEPA Creditor Identifier.

Declaration

public static string GetCountryCode(string sCreditorID)

Parameters

Type	Name	Description
string	sCreditorID	The creditor ID to extract the country code from.

Returns

Type	Description
string	If the given creditor ID was null or an empty string, then null is returned. Otherwise the first two characters from the string are returned.

Exceptions

Type	Condition
ArgumentException	The given creditor ID was not a valid string.

GetHashCode()

Provides an hash code based on the SEPA Creditor Identifier.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Hashcode.

Overrides

ValueType.GetHashCode()

IsValid(string)

Tests whether a string is a valid SEPA Creditor Identifier.

Declaration

public static bool IsValid(string sCreditorID)

Parameters

Type	Name	Description
string	sCreditorID

Returns

Type	Description
bool

SameCreditor(SepaCreditorID, SepaCreditorID)

Compares the given creditor IDs without the contained creditor business code.

Declaration

public static bool SameCreditor(SepaCreditorID tCreditorID1, SepaCreditorID tCreditorID2)

Parameters

Type	Name	Description
SepaCreditorID	tCreditorID1
SepaCreditorID	tCreditorID2

Returns

Type	Description
bool

SameCreditor(string, string)

Compares the given creditor IDs without the contained creditor business code.

Declaration

public static bool SameCreditor(string sCreditorID1, string sCreditorID2)

Parameters

Type	Name	Description
string	sCreditorID1
string	sCreditorID2

Returns

Type	Description
bool

ToString()

Returns the SEPA Creditor Identifier.

Declaration

public override string ToString()

Returns

Type	Description
string	SEPA Creditor Identifier.

Overrides

ValueType.ToString()

Operators

operator ==(SepaCreditorID, SepaCreditorID)

Equality operator compares the SEPA Creditor Identifier.

Declaration

public static bool operator ==(SepaCreditorID lhs, SepaCreditorID rhs)

Parameters

Type	Name	Description
SepaCreditorID	lhs
SepaCreditorID	rhs

Returns

Type	Description
bool

operator !=(SepaCreditorID, SepaCreditorID)

Inequality operator compares the SEPA Creditor Identifier.

Declaration

public static bool operator !=(SepaCreditorID lhs, SepaCreditorID rhs)

Parameters

Type	Name	Description
SepaCreditorID	lhs
SepaCreditorID	rhs

Returns

Type	Description
bool