Class FinSepaOutstandingPostdatedOrderBuilder
Base class for builders for query of SEPA outstanding postdated single remittance orders (HKCSB) or direct debit orders (HKDBS, HKBBS).
public class FinSepaOutstandingPostdatedOrderBuilder : FinOrderBuilder
- Inheritance
-
FinSepaOutstandingPostdatedOrderBuilder
- Derived
- Inherited Members
Constructors
FinSepaOutstandingPostdatedOrderBuilder(FinContact, SepaMessageType)
protected FinSepaOutstandingPostdatedOrderBuilder(FinContact aContact, SepaMessageType nMessageType)
Parameters
aContactFinContactnMessageTypeSepaMessageType
Properties
MaxEntriesAllowed
Indicates if a count may be specified in the query.
public bool MaxEntriesAllowed { get; }
Property Value
SupportedPainFormats
Returns an array of simple pain identifiers of the supported SEPA pain XML formats.
public string[] SupportedPainFormats { get; }
Property Value
- 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.
public string[] SupportedSepaFormats { get; }
Property Value
- 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.
public bool TimePeriodPossible { get; }
Property Value
Methods
Build(FinAcct)
Builds a specialized FinOrder for a HKCSB, HKDBS or HKBBS segment.
public FinSepaOutstandingPostdatedOrder Build(FinAcct aOrderAcct)
Parameters
aOrderAcctFinAcctThe ordering account for which to return the postdated order inventory. This must not be
null.
Returns
Build(FinAcct, string[], SwiftDate, SwiftDate, int, string)
Builds a specialized FinOrder for a HKCSB, HKDBS or HKBBS segment.
public FinSepaOutstandingPostdatedOrder Build(FinAcct aOrderAcct, string[] vsSupportedSepaFormats, SwiftDate aStartDate, SwiftDate aEndDate, int nMaxNoEntries, string sScrollRef)
Parameters
aOrderAcctFinAcctThe ordering account for which to return the postdated order inventory. This must not be
null.vsSupportedSepaFormatsstring[]Optional list of SEPA descriptors of the supported SEPA pain formats. If this parameter is
null, then all the SupportedSepaFormats will be used instead.aStartDateSwiftDateOptional starting date. Is only used when TimePeriodPossible is
true. Otherwise the parameter is ignored.aEndDateSwiftDateOptional ending date. Is only used when TimePeriodPossible is
true. Otherwise the parameter is ignored.nMaxNoEntriesintOptional max number of entries to return. Is only used when MaxEntriesAllowed is
true. Otherwise the parameter is ignored.sScrollRefstringOptional scroll reference from a previous inquiry or
null.