com.github.dannil.scbjavaclient.client.financialmarkets.securities

Class FinancialMarketsSecuritiesClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.financialmarkets.securities.FinancialMarketsSecuritiesClient

public class FinancialMarketsSecuritiesClient
extends AbstractClient

Client which handles financial markets securities data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<MaturityStructure>	getMaturityStructure() Fetch all maturity structure data.
List<MaturityStructure>	getMaturityStructure(Collection<Integer> sectors, Collection<String> maturities, Collection<String> currencies, Collection<String> months) Fetch all maturity structure data which match the input constraints.
List<OutstandingAndIssuedAmount>	getOutstandingAndIssuedAmount() Fetch all outstanding and issued amount data.
List<OutstandingAndIssuedAmount>	getOutstandingAndIssuedAmount(Collection<Integer> sectors, Collection<String> items, Collection<String> currencies, Collection<String> months) Fetch all outstanding and issued amount 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

FinancialMarketsSecuritiesClient

public FinancialMarketsSecuritiesClient()

Default constructor.

FinancialMarketsSecuritiesClient

public FinancialMarketsSecuritiesClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getMaturityStructure

public List<MaturityStructure> getMaturityStructure()

Fetch all maturity structure data.

Returns:

the maturity structure data wrapped in a list of MaturityStructure objects

See Also:

getMaturityStructure(Collection, Collection, Collection, Collection)

getMaturityStructure

public List<MaturityStructure> getMaturityStructure(Collection<Integer> sectors,
                                                    Collection<String> maturities,
                                                    Collection<String> currencies,
                                                    Collection<String> months)

Fetch all maturity structure data which match the input constraints.

Parameters:

sectors - the sectors to fetch data for

maturities - the maturities to fetch data for

currencies - the currencies to fetch data for

months - the months to fetch data for

Returns:

the maturity structure data wrapped in a list of MaturityStructure objects

getOutstandingAndIssuedAmount

public List<OutstandingAndIssuedAmount> getOutstandingAndIssuedAmount()

Fetch all outstanding and issued amount data.

Returns:

the outstanding and issued amount data wrapped in a list of OutstandingAndIssuedAmount objects

See Also:

getOutstandingAndIssuedAmount(Collection, Collection, Collection, Collection)

getOutstandingAndIssuedAmount

public List<OutstandingAndIssuedAmount> getOutstandingAndIssuedAmount(Collection<Integer> sectors,
                                                                      Collection<String> items,
                                                                      Collection<String> currencies,
                                                                      Collection<String> months)

Fetch all outstanding and issued amount data which match the input constraints.

Parameters:

sectors - the sectors 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 outstanding and issued amount data wrapped in a list of OutstandingAndIssuedAmount 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