Package com.github.dannil.scbjavaclient.client.financialmarkets.statistics.depositandlending

Class FinancialMarketsStatisticsDepositAndLendingClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.financialmarkets.statistics.depositandlending.FinancialMarketsStatisticsDepositAndLendingClient

public class FinancialMarketsStatisticsDepositAndLendingClient
extends AbstractClient

Client which handles financial markets statistics deposit and lending data fetching.

Since:

0.5.0

Constructor Summary

Constructors

Constructor	Description
FinancialMarketsStatisticsDepositAndLendingClient()	Default constructor.
FinancialMarketsStatisticsDepositAndLendingClient(Locale locale)	Overloaded constructor.

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getBanksDepositRates()	Fetch all banks deposit rates data.
List<ResponseModel>	getBanksDepositRates(Collection<String> referenceSectors, Collection<Integer> counterpartySectors, Collection<String> agreements, Collection<Integer> originalRateFixations, Collection<String> months)	Fetch all banks deposit rates data which match the input constraints.
List<ResponseModel>	getLendingRatesBreakdownByPurpose()	Fetch all lending rates breakdown by purpose data.
List<ResponseModel>	getLendingRatesBreakdownByPurpose(Collection<String> referenceSectors, Collection<String> counterpartySectors, Collection<String> agreements, Collection<String> purposes, Collection<String> months)	Fetch all lending rates breakdown by purpose data which match the input constraints.
List<ResponseModel>	getLendingRatesBreakdownByRemainingMaturity()	Fetch all lending rates breakdown by remaining maturity data.
List<ResponseModel>	getLendingRatesBreakdownByRemainingMaturity(Collection<String> referenceSectors, Collection<Integer> counterpartySectors, Collection<String> remainingMaturities, Collection<String> months)	Fetch all lending rates breakdown by remaining maturity data which match the input constraints.
List<ResponseModel>	getLendingRatesToHouseholdsAndNonFinancialCorporationsBreakdownByMaturity()	Fetch all lending rates to households and non-financial corporations breakdown by maturity data.
List<ResponseModel>	getLendingRatesToHouseholdsAndNonFinancialCorporationsBreakdownByMaturity(Collection<String> referenceSectors, Collection<String> counterpartySectors, Collection<String> agreements, Collection<String> originalRateFixations, Collection<String> months)	Fetch all lending rates to households and non-financial corporations breakdown by maturity data which match the input constraints.
List<ResponseModel>	getLendingRatesToHouseholdsForHousingLoansBreakdownByMaturity()	Fetch all lending rates to households for housing loans breakdown by maturity data.
List<ResponseModel>	getLendingRatesToHouseholdsForHousingLoansBreakdownByMaturity(Collection<String> referenceSectors, Collection<String> counterpartySectors, Collection<String> agreements, Collection<String> originalRateFixations, Collection<String> months)	Fetch all lending rates to households for housing loans breakdown by maturity 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

Methods inherited from class java.lang.Object

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

Constructor Detail

FinancialMarketsStatisticsDepositAndLendingClient

public FinancialMarketsStatisticsDepositAndLendingClient()

Default constructor.

FinancialMarketsStatisticsDepositAndLendingClient

public FinancialMarketsStatisticsDepositAndLendingClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getLendingRatesBreakdownByRemainingMaturity

public List<ResponseModel> getLendingRatesBreakdownByRemainingMaturity()

Fetch all lending rates breakdown by remaining maturity data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLendingRatesBreakdownByRemainingMaturity(Collection, Collection, Collection, Collection)

getLendingRatesBreakdownByRemainingMaturity

public List<ResponseModel> getLendingRatesBreakdownByRemainingMaturity(Collection<String> referenceSectors,
                                                                       Collection<Integer> counterpartySectors,
                                                                       Collection<String> remainingMaturities,
                                                                       Collection<String> months)

Fetch all lending rates breakdown by remaining maturity data which match the input constraints.

Parameters:

referenceSectors - the reference sectors

counterpartySectors - the counterparty sectors

remainingMaturities - the remaining maturities

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getLendingRatesToHouseholdsForHousingLoansBreakdownByMaturity

public List<ResponseModel> getLendingRatesToHouseholdsForHousingLoansBreakdownByMaturity()

Fetch all lending rates to households for housing loans breakdown by maturity data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLendingRatesToHouseholdsForHousingLoansBreakdownByMaturity(Collection, Collection, Collection, Collection, Collection)

getLendingRatesToHouseholdsForHousingLoansBreakdownByMaturity

public List<ResponseModel> getLendingRatesToHouseholdsForHousingLoansBreakdownByMaturity(Collection<String> referenceSectors,
                                                                                         Collection<String> counterpartySectors,
                                                                                         Collection<String> agreements,
                                                                                         Collection<String> originalRateFixations,
                                                                                         Collection<String> months)

Fetch all lending rates to households for housing loans breakdown by maturity data which match the input constraints.

Parameters:

referenceSectors - the reference sectors

counterpartySectors - the counterparty sectors

agreements - the agreements

originalRateFixations - the original rate fixations

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getLendingRatesToHouseholdsAndNonFinancialCorporationsBreakdownByMaturity

public List<ResponseModel> getLendingRatesToHouseholdsAndNonFinancialCorporationsBreakdownByMaturity()

Fetch all lending rates to households and non-financial corporations breakdown by maturity data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLendingRatesToHouseholdsAndNonFinancialCorporationsBreakdownByMaturity(Collection, Collection, Collection, Collection, Collection)

getLendingRatesToHouseholdsAndNonFinancialCorporationsBreakdownByMaturity

public List<ResponseModel> getLendingRatesToHouseholdsAndNonFinancialCorporationsBreakdownByMaturity(Collection<String> referenceSectors,
                                                                                                     Collection<String> counterpartySectors,
                                                                                                     Collection<String> agreements,
                                                                                                     Collection<String> originalRateFixations,
                                                                                                     Collection<String> months)

Fetch all lending rates to households and non-financial corporations breakdown by maturity data which match the input constraints.

Parameters:

referenceSectors - the reference sectors

counterpartySectors - the counterparty sectors

agreements - the agreements

originalRateFixations - the original rate fixations

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getLendingRatesBreakdownByPurpose

public List<ResponseModel> getLendingRatesBreakdownByPurpose()

Fetch all lending rates breakdown by purpose data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLendingRatesBreakdownByPurpose(Collection, Collection, Collection, Collection, Collection)

getLendingRatesBreakdownByPurpose

public List<ResponseModel> getLendingRatesBreakdownByPurpose(Collection<String> referenceSectors,
                                                             Collection<String> counterpartySectors,
                                                             Collection<String> agreements,
                                                             Collection<String> purposes,
                                                             Collection<String> months)

Fetch all lending rates breakdown by purpose data which match the input constraints.

Parameters:

referenceSectors - the reference sectors

counterpartySectors - the counterparty sectors

agreements - the agreements

purposes - the purposes

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getBanksDepositRates

public List<ResponseModel> getBanksDepositRates()

Fetch all banks deposit rates data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getBanksDepositRates(Collection, Collection, Collection, Collection, Collection)

getBanksDepositRates

public List<ResponseModel> getBanksDepositRates(Collection<String> referenceSectors,
                                                Collection<Integer> counterpartySectors,
                                                Collection<String> agreements,
                                                Collection<Integer> originalRateFixations,
                                                Collection<String> months)

Fetch all banks deposit rates data which match the input constraints.

Parameters:

referenceSectors - the reference sectors

counterpartySectors - the counterparty sectors

agreements - the agreements

originalRateFixations - the original rate fixations

months - the months

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 class AbstractClient

Returns:

the URL endpoint for this client