com.github.dannil.scbjavaclient.client.publicfinances.assetsandliabilities

Class PublicFinancesAssetsAndLiabilitiesClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.publicfinances.assetsandliabilities.PublicFinancesAssetsAndLiabilitiesClient

public class PublicFinancesAssetsAndLiabilitiesClient
extends AbstractClient

Client which handles public finances assets and liabilities data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getAssetsAndLiabilities() Fetch all assets and liabilities data.
List<ResponseModel>	getAssetsAndLiabilities(Collection<Integer> items, Collection<Integer> sectors, Collection<String> quarters) Fetch all assets and liabilities 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

PublicFinancesAssetsAndLiabilitiesClient

public PublicFinancesAssetsAndLiabilitiesClient()

Default constructor.

PublicFinancesAssetsAndLiabilitiesClient

public PublicFinancesAssetsAndLiabilitiesClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getAssetsAndLiabilities

public List<ResponseModel> getAssetsAndLiabilities()

Fetch all assets and liabilities data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAssetsAndLiabilities(Collection, Collection, Collection)

getAssetsAndLiabilities

public List<ResponseModel> getAssetsAndLiabilities(Collection<Integer> items,
                                                   Collection<Integer> sectors,
                                                   Collection<String> quarters)

Fetch all assets and liabilities data which match the input constraints.

Parameters:

items - the items

sectors - the sectors

quarters - the quarters

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