Class FinSingOrderBuilder

Namespace
Subsembly.FinTS
Assembly
Subsembly.FinTS.Core.dll

Generic FinOrderBuilder base class. With the abolition of the old IZV, this class is solely used for HKUMB orders (FinReclassificationBuilder).

public abstract class FinSingOrderBuilder : FinOrderBuilder
Inheritance
FinSingOrderBuilder
Derived
Inherited Members

Remarks

A FinSingOrderBuilder cannot be instantiated directly, but rather the more specialised derived classes such as FinReclassificationBuilder must be used.

Constructors

FinSingOrderBuilder(FinContact)

protected FinSingOrderBuilder(FinContact aContact)

Parameters

aContact FinContact

Properties

MaxNoPaymtPurposeLines

Provides the maximum number of payment purpose lines that may be used in the remittance order.

public int MaxNoPaymtPurposeLines { get; }

Property Value

int

SupportedTextKeys

Provides an array with all the supported text keys that may be used in the remittance order.

public string[] SupportedTextKeys { get; }

Property Value

string[]

Methods

Build(FinRemitt)

Builds a single payment order from the given remittance data.

public virtual FinOrder Build(FinRemitt aRemitt)

Parameters

aRemitt FinRemitt

Remittance data to build the order from. Depending on the type of order to be actually built, this may require an OrderID.

Returns

FinOrder

The completely built and ready to execute FinOrder derived payment.

Remarks

A specialized builder may override this method in order to build and return another order type derived from FinOrder.

BuildRemittSegment(FinRemitt)

Builds a single order segment from the given remittance data.

protected FinSegment BuildRemittSegment(FinRemitt aRemitt)

Parameters

aRemitt FinRemitt

Remittance data to build the single order segment from. All required fields must have been initialised. Must not be null.

Returns

FinSegment

A completely initialised single order segment.

IsSupportedTextKey(string)

Checks whether a particular TextKey is supported.

public bool IsSupportedTextKey(string sTextKey)

Parameters

sTextKey string

The TextKey to search for. Must not be null.

Returns

bool

If the requested TextKey is supported, then true is returned. If it is not found in the parameter segment, then false is returned.

SetParamsGD(int, int)

Set the parameter GD positions of the common single remittance parameters.

protected void SetParamsGD(int nMaxNoPaymtPurposeLinesGD, int nSupportedTextKeysGD)

Parameters

nMaxNoPaymtPurposeLinesGD int

GD position of the MaxNoPaymtPurposeLines parameter. If not set, then the default position 1 is assumed.

nSupportedTextKeysGD int

First GD position of the SupportedTextKeys parameters. If not set, then the default position 2 is assumed.