Struct SepaRF

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

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.ReferenceEquals(System.Object, System.Object)

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
System.String	sReference

Fields

MAXLENGTH

The max length including prefix and checkdigits

Declaration

public const int MAXLENGTH = 25

Field Value

Type	Description
System.Int32

MINLENGTH

The min length including prefix and checkdigits

Declaration

public const int MINLENGTH = 5

Field Value

Type	Description
System.Int32

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
System.String

Properties

IsNull

Indicates whether this SepaRF is the NullRF.

Declaration

public readonly bool IsNull { get; }

Property Value

Type	Description
System.Boolean

Reference

Provides the complete wrapped SepaRF in its electronic format.

Declaration

public readonly string Reference { get; }

Property Value

Type	Description
System.String

ReferenceValue

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

Declaration

public readonly string ReferenceValue { get; }

Property Value

Type	Description
System.String

Methods

Capture(String)

Declaration

public static string Capture(string sPaperReference)

Parameters

Type	Name	Description
System.String	sPaperReference

Returns

Type	Description
System.String

Equals(Object)

Compares the electronic SepaRF representation for equivalence.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	Right hand side to compare to.

Returns

Type	Description
System.Boolean	True if both are essentially the same SepaRF.

Overrides

System.ValueType.Equals(System.Object)

Format()

Declaration

public string Format()

Returns

Type	Description
System.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
System.String	sReference

Returns

Type	Description
System.String

GetHashCode()

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

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hashcode.

Overrides

System.ValueType.GetHashCode()

IsValid(String)

Declaration

public static bool IsValid(string sReference)

Parameters

Type	Name	Description
System.String	sReference

Returns

Type	Description
System.Boolean

ToString()

Returns the electronic format of this SepaRF.

Declaration

public override string ToString()

Returns

Type	Description
System.String	Electronic format of this SepaRF.

Overrides

System.ValueType.ToString()

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
System.String	sPaperReference

Returns

Type	Description
SepaRF

Operators

Equality(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
System.Boolean

Inequality(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
System.Boolean