Package com.github.dannil.scbjavaclient.client.publicfinances.governmentdebt

Class PublicFinancesGovernmentDebtClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.publicfinances.governmentdebt.PublicFinancesGovernmentDebtClient

public class PublicFinancesGovernmentDebtClient
extends AbstractClient

Client which handles public finances government debt data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getGovernmentDebt()	Fetch all government debt data.
List<ResponseModel>	getGovernmentDebt(Collection<String> items, Collection<String> months)	Fetch all government debt 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

PublicFinancesGovernmentDebtClient

public PublicFinancesGovernmentDebtClient()

Default constructor.

PublicFinancesGovernmentDebtClient

public PublicFinancesGovernmentDebtClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getGovernmentDebt

public List<ResponseModel> getGovernmentDebt()

Fetch all government debt data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getGovernmentDebt(Collection, Collection)

getGovernmentDebt

public List<ResponseModel> getGovernmentDebt(Collection<String> items,
                                             Collection<String> months)

Fetch all government debt data which match the input constraints.

Parameters:

items - the items

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