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 Description FinancialMarketsInstitutionsClient()
Default constructor.FinancialMarketsInstitutionsClient(Locale locale)
Overloaded constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<ResponseModel>
getAssets()
Fetch all institution assets data.List<ResponseModel>
getAssets(Collection<String> institutions, Collection<String> items, Collection<String> currencies, Collection<String> months)
Fetch all institution assets data which match the input constraints.URLEndpoint
getUrl()
Returns the URL endpoint which this client represents.-
Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractClient
doGetRequest, doPostRequest, getCommunicationProtocol, getLocale, getLocalizationLocale, getResponseModels, getResponseModels, getRootUrl, setCommunicationProtocol, setLocale, setLocalizationLocale
-
-
-
-
Constructor Detail
-
FinancialMarketsInstitutionsClient
public FinancialMarketsInstitutionsClient()
Default constructor.
-
FinancialMarketsInstitutionsClient
public FinancialMarketsInstitutionsClient(Locale locale)
Overloaded constructor.
- Parameters:
locale
- theLocale
for this client
-
-
Method Detail
-
getAssets
public List<ResponseModel> getAssets()
Fetch all institution assets data.
- Returns:
- the data wrapped in a list of
ResponseModel
objects - See Also:
getAssets(Collection, Collection, Collection, Collection)
-
getAssets
public List<ResponseModel> 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 foritems
- the items to fetch data forcurrencies
- the currencies to fetch data formonths
- the months to fetch data for- Returns:
- the data wrapped in a list of
ResponseModel
objects
-
getUrl
public URLEndpoint getUrl()
Description copied from class:AbstractClient
Returns the URL endpoint which this client represents.
- Specified by:
getUrl
in classAbstractClient
- Returns:
- the URL endpoint for this client
-
-