com.github.dannil.scbjavaclient.client.publicfinances.annualaccounts.balancesheetmunicipality

Class PublicFinancesAnnualAccountsBalanceSheetMunicipalityClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.publicfinances.annualaccounts.balancesheetmunicipality.PublicFinancesAnnualAccountsBalanceSheetMunicipalityClient

public class PublicFinancesAnnualAccountsBalanceSheetMunicipalityClient
extends AbstractClient

Client which handles public finances annual accounts balance sheet municipality data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getBalanceSheet() Fetch all balance sheet data.
List<ResponseModel>	getBalanceSheet(Collection<String> regions, Collection<String> balanceSheets, Collection<Integer> years) Fetch all balance sheet data which match the input constraints.
List<ResponseModel>	getGuaranteesAndContingentLiabilities() Fetch all guarantees and contingent liabilities data.
List<ResponseModel>	getGuaranteesAndContingentLiabilities(Collection<String> regions, Collection<Integer> typesOfGuarantees, Collection<Integer> years) Fetch all guarantees and contingent liabilities data which match the input constraints.
List<ResponseModel>	getIncomeStatements() Fetch all income statements data.
List<ResponseModel>	getIncomeStatements(Collection<String> regions, Collection<String> incomeStatements, Collection<Integer> years) Fetch all income statements data which match the input constraints.
List<ResponseModel>	getLocalGovernmentIncomes() Fetch all local government incomes data.
List<ResponseModel>	getLocalGovernmentIncomes(Collection<String> regions, Collection<Integer> items, Collection<Integer> years) Fetch all local government incomes data which match the input constraints.
List<ResponseModel>	getMunicipalitiesCosts() Fetch all municipalities costs data.
List<ResponseModel>	getMunicipalitiesCosts(Collection<String> regions, Collection<Integer> items, Collection<Integer> years) Fetch all municipalities costs 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

PublicFinancesAnnualAccountsBalanceSheetMunicipalityClient

public PublicFinancesAnnualAccountsBalanceSheetMunicipalityClient()

Default constructor.

PublicFinancesAnnualAccountsBalanceSheetMunicipalityClient

public PublicFinancesAnnualAccountsBalanceSheetMunicipalityClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getIncomeStatements

public List<ResponseModel> getIncomeStatements()

Fetch all income statements data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getIncomeStatements(Collection, Collection, Collection)

getIncomeStatements

public List<ResponseModel> getIncomeStatements(Collection<String> regions,
                                               Collection<String> incomeStatements,
                                               Collection<Integer> years)

Fetch all income statements data which match the input constraints.

Parameters:

regions - the regions

incomeStatements - the income statements

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getBalanceSheet

public List<ResponseModel> getBalanceSheet()

Fetch all balance sheet data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getBalanceSheet(Collection, Collection, Collection)

getBalanceSheet

public List<ResponseModel> getBalanceSheet(Collection<String> regions,
                                           Collection<String> balanceSheets,
                                           Collection<Integer> years)

Fetch all balance sheet data which match the input constraints.

Parameters:

regions - the regions

balanceSheets - the balance sheets

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getGuaranteesAndContingentLiabilities

public List<ResponseModel> getGuaranteesAndContingentLiabilities()

Fetch all guarantees and contingent liabilities data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getGuaranteesAndContingentLiabilities(Collection, Collection, Collection)

getGuaranteesAndContingentLiabilities

public List<ResponseModel> getGuaranteesAndContingentLiabilities(Collection<String> regions,
                                                                 Collection<Integer> typesOfGuarantees,
                                                                 Collection<Integer> years)

Fetch all guarantees and contingent liabilities data which match the input constraints.

Parameters:

regions - the regions

typesOfGuarantees - the types of guarantees

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getLocalGovernmentIncomes

public List<ResponseModel> getLocalGovernmentIncomes()

Fetch all local government incomes data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLocalGovernmentIncomes(Collection, Collection, Collection)

getLocalGovernmentIncomes

public List<ResponseModel> getLocalGovernmentIncomes(Collection<String> regions,
                                                     Collection<Integer> items,
                                                     Collection<Integer> years)

Fetch all local government incomes data which match the input constraints.

Parameters:

regions - the regions

items - the items

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getMunicipalitiesCosts

public List<ResponseModel> getMunicipalitiesCosts()

Fetch all municipalities costs data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getMunicipalitiesCosts(Collection, Collection, Collection)

getMunicipalitiesCosts

public List<ResponseModel> getMunicipalitiesCosts(Collection<String> regions,
                                                  Collection<Integer> items,
                                                  Collection<Integer> years)

Fetch all municipalities costs data which match the input constraints.

Parameters:

regions - the regions

items - the items

years - the years

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