com.github.dannil.scbjavaclient.client.financialmarkets.investmentfunds

Class FinancialMarketsInvestmentFundsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.financialmarkets.investmentfunds.FinancialMarketsInvestmentFundsClient

public class FinancialMarketsInvestmentFundsClient
extends AbstractClient

Client which handles financial markets investment funds data fetching.

Since:

0.2.0

Constructor Summary

Constructors

Constructor and Description
FinancialMarketsInvestmentFundsClient() Default constructor.
FinancialMarketsInvestmentFundsClient(Locale locale) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
List<OwnershipOfInvestmentFundShares>	getOwnershipOfInvestmentFundShares() Fetch all ownership of investment fund shares data.
List<OwnershipOfInvestmentFundShares>	getOwnershipOfInvestmentFundShares(Collection<String> types, Collection<String> sectors, Collection<String> quarters) Fetch all ownership of investment fund shares data which match the input constraints.
String	getUrl() Returns the URL endpoint which this client represents.

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractClient

doGetRequest, doPostRequest, getLocale, getLocalizationLocale, getRootUrl, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FinancialMarketsInvestmentFundsClient

public FinancialMarketsInvestmentFundsClient()

Default constructor.

FinancialMarketsInvestmentFundsClient

public FinancialMarketsInvestmentFundsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getOwnershipOfInvestmentFundShares

public List<OwnershipOfInvestmentFundShares> getOwnershipOfInvestmentFundShares()

Fetch all ownership of investment fund shares data.

Returns:

the ownership of investment fund shares data wrapped in a list of OwnershipOfInvestmentFundShares objects

See Also:

getOwnershipOfInvestmentFundShares(Collection, Collection, Collection)

getOwnershipOfInvestmentFundShares

public List<OwnershipOfInvestmentFundShares> getOwnershipOfInvestmentFundShares(Collection<String> types,
                                                                                Collection<String> sectors,
                                                                                Collection<String> quarters)

Fetch all ownership of investment fund shares data which match the input constraints.

Parameters:

types - the types to fetch data for

sectors - the sectors to fetch data for

quarters - the quarters to fetch data for

Returns:

the ownership of investment fund shares data wrapped in a list of OwnershipOfInvestmentFundShares objects

getUrl

public String getUrl()

Description copied from class: AbstractClient

Returns the URL endpoint which this client represents.

Specified by:

getUrl in class AbstractClient

Returns:

the URL endpoint for this client