Class FinSingOrderBuilder

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

Inheritance
System.Object
FinOrderBuilder
FinSingOrderBuilder
FinReclassificationBuilder
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Subsembly.FinTS
Assembly: Subsembly.FinTS.Core.dll
Syntax
public abstract class FinSingOrderBuilder : FinOrderBuilder
Remarks

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

Constructors

FinSingOrderBuilder(FinContact)

Declaration
protected FinSingOrderBuilder(FinContact aContact)
Parameters
Type Name Description
FinContact aContact

Properties

MaxNoPaymtPurposeLines

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

Declaration
public int MaxNoPaymtPurposeLines { get; }
Property Value
Type Description
System.Int32

SupportedTextKeys

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

Declaration
public string[] SupportedTextKeys { get; }
Property Value
Type Description
System.String[]

Methods

Build(FinRemitt)

Builds a single payment order from the given remittance data.

Declaration
public virtual FinOrder Build(FinRemitt aRemitt)
Parameters
Type Name Description
FinRemitt aRemitt

Remittance data to build the order from. Depending on the type of order to be actually built, this may require an OrderID.
Returns
Type Description
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.

Declaration
protected FinSegment BuildRemittSegment(FinRemitt aRemitt)
Parameters
Type Name Description
FinRemitt aRemitt

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

A completely initialised single order segment.

CreateOrder(FinSegment)

Declaration
protected virtual FinOrder CreateOrder(FinSegment aSegment)
Parameters
Type Name Description
FinSegment aSegment
Returns
Type Description
FinOrder

IsSupportedTextKey(String)

Checks whether a particular TextKey is supported.

Declaration
public bool IsSupportedTextKey(string sTextKey)
Parameters
Type Name Description
System.String sTextKey

The TextKey to search for. Must not be null.
Returns
Type Description
System.Boolean

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

SetParamsGD(Int32, Int32)

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

Declaration
protected void SetParamsGD(int nMaxNoPaymtPurposeLinesGD, int nSupportedTextKeysGD)
Parameters
Type Name Description
System.Int32 nMaxNoPaymtPurposeLinesGD

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

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