Class FinSepaOutstandingPostdatedOrderBuilder

Base class for builders for query of SEPA outstanding postdated single remittance orders (HKCSB) or direct debit orders (HKDBS, HKBBS).

Inheritance
System.Object
FinOrderBuilder
FinSepaOutstandingPostdatedOrderBuilder
FinSepaOutstandingPostdatedBusinessSingDirDebBuilder
FinSepaOutstandingPostdatedSingDirDebBuilder
FinSepaOutstandingPostdatedSingRemittBuilder
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 class FinSepaOutstandingPostdatedOrderBuilder : FinOrderBuilder

Constructors

FinSepaOutstandingPostdatedOrderBuilder(FinContact, SepaMessageType)

Declaration
protected FinSepaOutstandingPostdatedOrderBuilder(FinContact aContact, SepaMessageType nMessageType)
Parameters
Type Name Description
FinContact aContact
SepaMessageType nMessageType

Properties

MaxEntriesAllowed

Indicates if a count may be specified in the query.

Declaration
public bool MaxEntriesAllowed { get; }
Property Value
Type Description
System.Boolean

SupportedPainFormats

Returns an array of simple pain identifiers of the supported SEPA pain XML formats.

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

The returned array may be empty, but is never null.

SupportedSepaFormats

Returns an array with the descriptors (URN) of the SEPA XML formats supported by this builder.

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

The data provided by actual banks is widely different and inconclusive. Thus this information is rather worthless and should be ignored. Use the processed SupportedPainFormats instead.

TimePeriodPossible

Indicates if a start and/or ending date may be specified in the query.

Declaration
public bool TimePeriodPossible { get; }
Property Value
Type Description
System.Boolean

Methods

Build(FinAcct)

Builds a specialized FinOrder for a HKCSB, HKDBS or HKBBS segment.

Declaration
public FinSepaOutstandingPostdatedOrder Build(FinAcct aOrderAcct)
Parameters
Type Name Description
FinAcct aOrderAcct

The ordering account for which to return the postdated order inventory. This must not be null.
Returns
Type Description
FinSepaOutstandingPostdatedOrder

Build(FinAcct, String[], SwiftDate, SwiftDate, Int32, String)

Builds a specialized FinOrder for a HKCSB, HKDBS or HKBBS segment.

Declaration
public FinSepaOutstandingPostdatedOrder Build(FinAcct aOrderAcct, string[] vsSupportedSepaFormats, SwiftDate aStartDate, SwiftDate aEndDate, int nMaxNoEntries, string sScrollRef)
Parameters
Type Name Description
FinAcct aOrderAcct

The ordering account for which to return the postdated order inventory. This must not be null.
System.String[] vsSupportedSepaFormats

Optional list of SEPA descriptors of the supported SEPA pain formats. If this parameter is null, then all the SupportedSepaFormats will be used instead.
SwiftDate aStartDate

Optional starting date. Is only used when TimePeriodPossible is true. Otherwise the parameter is ignored.
SwiftDate aEndDate

Optional ending date. Is only used when TimePeriodPossible is true. Otherwise the parameter is ignored.
System.Int32 nMaxNoEntries

Optional max number of entries to return. Is only used when MaxEntriesAllowed is true. Otherwise the parameter is ignored.
System.String sScrollRef

Optional scroll reference from a previous inquiry or null.
Returns
Type Description
FinSepaOutstandingPostdatedOrder