com.github.dannil.scbjavaclient.client.financialmarkets.institutions

Class FinancialMarketsInstitutionsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.financialmarkets.institutions.FinancialMarketsInstitutionsClient

public class FinancialMarketsInstitutionsClient
extends AbstractClient

Client which handles financial markets institutions data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<MonetaryAssets>	getAssets() Fetch all institution assets data.
List<MonetaryAssets>	getAssets(Collection<String> institutions, Collection<String> items, Collection<String> currencies, Collection<String> months) Fetch all institution assets 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

FinancialMarketsInstitutionsClient

public FinancialMarketsInstitutionsClient()

Default constructor.

FinancialMarketsInstitutionsClient

public FinancialMarketsInstitutionsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getAssets

public List<MonetaryAssets> getAssets()

Fetch all institution assets data.

Returns:

the institution assets data wrapped in a list of MonetaryAssets objects

See Also:

getAssets(Collection, Collection, Collection, Collection)

getAssets

public List<MonetaryAssets> getAssets(Collection<String> institutions,
                                      Collection<String> items,
                                      Collection<String> currencies,
                                      Collection<String> months)

Fetch all institution assets data which match the input constraints.

Parameters:

institutions - the institutions to fetch data for

items - the items to fetch data for

currencies - the currencies to fetch data for

months - the months to fetch data for

Returns:

the institution data wrapped in a list of MonetaryAssets 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