Class FinPortfListBuilder

Builder for security portfolio list requests (HKWPD).

Inheritance
System.Object
FinOrderBuilder
FinPortfListBuilder
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 FinPortfListBuilder : FinOrderBuilder
Remarks

The name of this class is based on the FinTS 4.0 XML Tag-name of that same order type, which is <PortfList>.

Constructors

FinPortfListBuilder(FinContact)

Declaration
public FinPortfListBuilder(FinContact aContact)
Parameters
Type Name Description
FinContact aContact

Properties

ExchRateQualityAvailable

True if the request parameter ExchRateQuality may be set.

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

MaxEntriesAllowed

True if the request parameter MaxNoEntries may be set.

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

PortfolioSecListCcyAvail

True if the request parameter PortfolioSecurListCcy may be set.

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

Methods

Build(FinAcct, String, FinExchRateQuality, Int32, String)

Builds a portfolio list request (HKWPD) from the given parameters.

Declaration
public FinPortfList Build(FinAcct aOrderAcct, string sPortfolioSecurListCcy, FinExchRateQuality nExchRateQuality, int nMaxNoEntries, string sScrollRef)
Parameters
Type Name Description
FinAcct aOrderAcct

The ordering customers account information. This must refer to a valid securities portfolio of the customer.
System.String sPortfolioSecurListCcy

Selects the currency of the requested portfolio. This may only be supplied if PortfolioSecListCcyAvail is true. Otherwise this parameter shall be null.
FinExchRateQuality nExchRateQuality

Selects the quality of the quoted stock prices in the portfolio list. If ExchRateQualityAvailable is false, then this parameter must be Unknown.
System.Int32 nMaxNoEntries

Optional max number of entries to return. Must only be specified when MaxEntriesAllowed is true. Must be zero, otherwise.
System.String sScrollRef

Optional scroll reference from a previous inquiry.
Returns
Type Description
FinPortfList

Initialised instance of FinPortfList request that is ready to be executed.