Struct SepaRF

Helper class for working with a Structured Creditor Reference, and other, similarily composed reference values.

Inherited Members
Namespace: Subsembly.Sepa
Assembly: Subsembly.Sepa.dll
Syntax
public struct SepaRF
Remarks

A SepaRF always consists of two upper case characters, followed by two check digits, followed by the actual reference value characters. For a Structured Creditor Reference, the reference always begins with upper case "RF".

Constructors

SepaRF(string)

Declaration
public SepaRF(string sReference)
Parameters
Type Name Description
string sReference

Fields

MAXLENGTH

The max length including prefix and checkdigits

Declaration
public const int MAXLENGTH = 25
Field Value
Type Description
int

MINLENGTH

The min length including prefix and checkdigits

Declaration
public const int MINLENGTH = 5
Field Value
Type Description
int

NullRF

Represents an unset SepaRF instance.

Declaration
public static readonly SepaRF NullRF
Field Value
Type Description
SepaRF

RF

The prefix that must be used with a Structured Creditor Reference.

Declaration
public const string RF = "RF"
Field Value
Type Description
string

Properties

IsNull

Indicates whether this SepaRF is the NullRF.

Declaration
public bool IsNull { get; }
Property Value
Type Description
bool

Reference

Provides the complete wrapped SepaRF in its electronic format.

Declaration
public string Reference { get; }
Property Value
Type Description
string

ReferenceValue

Provides the value of the reference without prefix and check digits.

Declaration
public string ReferenceValue { get; }
Property Value
Type Description
string

Methods

Capture(string)

Declaration
public static string Capture(string sPaperReference)
Parameters
Type Name Description
string sPaperReference
Returns
Type Description
string

Equals(object)

Compares the electronic SepaRF representation 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 SepaRF.
Overrides

Format()

Declaration
public string Format()
Returns
Type Description
string

Format(string)

Nicely formats the given reference string input into groups of four characters.

Declaration
public static string Format(string sReference)
Parameters
Type Name Description
string sReference
Returns
Type Description
string

GetHashCode()

Provides an hash code based on the electronic SepaRF representation of this SepaRF.

Declaration
public override int GetHashCode()
Returns
Type Description
int

Hashcode.
Overrides

IsValid(string)

Declaration
public static bool IsValid(string sReference)
Parameters
Type Name Description
string sReference
Returns
Type Description
bool

ToString()

Returns the electronic format of this SepaRF.

Declaration
public override string ToString()
Returns
Type Description
string

Electronic format of this SepaRF.
Overrides

TryCapture(string)

Tries to Capture(string) a SepaRF. If no valid reference was captured, then NullRF is returned.

Declaration
public static SepaRF TryCapture(string sPaperReference)
Parameters
Type Name Description
string sPaperReference
Returns
Type Description
SepaRF

Operators

operator ==(SepaRF, SepaRF)

Equality operator compares the electronic format of the SepaRF.

Declaration
public static bool operator ==(SepaRF lhs, SepaRF rhs)
Parameters
Type Name Description
SepaRF lhs
SepaRF rhs
Returns
Type Description
bool

operator !=(SepaRF, SepaRF)

Inequality operator compares the electronic format of the SepaRF.

Declaration
public static bool operator !=(SepaRF lhs, SepaRF rhs)
Parameters
Type Name Description
SepaRF lhs
SepaRF rhs
Returns
Type Description
bool