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

Class PublicFinancesPubliclyOwnedEnterprisesClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.publicfinances.publiclyownedenterprises.PublicFinancesPubliclyOwnedEnterprisesClient

public class PublicFinancesPubliclyOwnedEnterprisesClient
extends AbstractClient

Client which handles public finances publicly owned enterprises data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getAssets()	Fetch all assets data.
List<ResponseModel>	getAssets(Collection<String> sectors, Collection<Integer> typesOfOwnerships, Collection<String> industrialClassifications, Collection<Integer> years)	Fetch all assets data which match the input constraints.
List<ResponseModel>	getCountyCouncilsEnterprises()	Fetch all county councils enterprises data.
List<ResponseModel>	getCountyCouncilsEnterprises(Collection<String> regions, Collection<String> sectors, Collection<Integer> years)	Fetch all county councils enterprises data which match the input constraints.
List<ResponseModel>	getDataForMunicipalityOwnedEnterprises()	Fetch all municipality owned enterprises data.
List<ResponseModel>	getDataForMunicipalityOwnedEnterprises(Collection<String> regions, Collection<Integer> years)	Fetch all municipality owned enterprises data which match the input constraints.
List<ResponseModel>	getEnterprises()	Fetch all enterprises data.
List<ResponseModel>	getEnterprises(Collection<String> regions, Collection<Integer> years)	Fetch all enterprises data which match the input constraints.
List<ResponseModel>	getIncomeStatements()	Fetch all income statements data.
List<ResponseModel>	getIncomeStatements(Collection<String> sectors, Collection<Integer> typesOfOwnerships, Collection<String> industrialClassifications, Collection<Integer> years)	Fetch all income statements data which match the input constraints.
List<ResponseModel>	getLiabilitiesAndEquity()	Fetch all liabilities and equity data.
List<ResponseModel>	getLiabilitiesAndEquity(Collection<String> sectors, Collection<Integer> typesOfOwnerships, Collection<String> industrialClassifications, Collection<Integer> years)	Fetch all liabilities and equity data which match the input constraints.
List<ResponseModel>	getPubliclyOwnedEnterprises()	Fetch all publicly owned enterprises data.
List<ResponseModel>	getPubliclyOwnedEnterprises(Collection<String> sectors, Collection<Integer> typesOfOwnerships, Collection<Integer> legalEntities, Collection<Integer> years)	Fetch all publicly owned enterprises 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

PublicFinancesPubliclyOwnedEnterprisesClient

public PublicFinancesPubliclyOwnedEnterprisesClient()

Default constructor.

PublicFinancesPubliclyOwnedEnterprisesClient

public PublicFinancesPubliclyOwnedEnterprisesClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getDataForMunicipalityOwnedEnterprises

public List<ResponseModel> getDataForMunicipalityOwnedEnterprises()

Fetch all municipality owned enterprises data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getDataForMunicipalityOwnedEnterprises(Collection, Collection)

getDataForMunicipalityOwnedEnterprises

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

Fetch all municipality owned enterprises data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getEnterprises

public List<ResponseModel> getEnterprises()

Fetch all enterprises data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getEnterprises(Collection, Collection)

getEnterprises

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

Fetch all enterprises data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getCountyCouncilsEnterprises

public List<ResponseModel> getCountyCouncilsEnterprises()

Fetch all county councils enterprises data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getCountyCouncilsEnterprises(Collection, Collection, Collection)

getCountyCouncilsEnterprises

public List<ResponseModel> getCountyCouncilsEnterprises(Collection<String> regions,
                                                        Collection<String> sectors,
                                                        Collection<Integer> years)

Fetch all county councils enterprises data which match the input constraints.

Parameters:

regions - the regions

sectors - the sectors

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getPubliclyOwnedEnterprises

public List<ResponseModel> getPubliclyOwnedEnterprises()

Fetch all publicly owned enterprises data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPubliclyOwnedEnterprises(Collection, Collection, Collection, Collection)

getPubliclyOwnedEnterprises

public List<ResponseModel> getPubliclyOwnedEnterprises(Collection<String> sectors,
                                                       Collection<Integer> typesOfOwnerships,
                                                       Collection<Integer> legalEntities,
                                                       Collection<Integer> years)

Fetch all publicly owned enterprises data which match the input constraints.

Parameters:

sectors - the sectors

typesOfOwnerships - the types of ownerships

legalEntities - the legal entities

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

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, Collection)

getIncomeStatements

public List<ResponseModel> getIncomeStatements(Collection<String> sectors,
                                               Collection<Integer> typesOfOwnerships,
                                               Collection<String> industrialClassifications,
                                               Collection<Integer> years)

Fetch all income statements data which match the input constraints.

Parameters:

sectors - the sectors

typesOfOwnerships - the types of ownerships

industrialClassifications - the industrial classifications

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getLiabilitiesAndEquity

public List<ResponseModel> getLiabilitiesAndEquity()

Fetch all liabilities and equity data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLiabilitiesAndEquity(Collection, Collection, Collection, Collection)

getLiabilitiesAndEquity

public List<ResponseModel> getLiabilitiesAndEquity(Collection<String> sectors,
                                                   Collection<Integer> typesOfOwnerships,
                                                   Collection<String> industrialClassifications,
                                                   Collection<Integer> years)

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

Parameters:

sectors - the sectors

typesOfOwnerships - the types of ownerships

industrialClassifications - the industrial classifications

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getAssets

public List<ResponseModel> getAssets()

Fetch all assets data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAssets(Collection, Collection, Collection, Collection)

getAssets

public List<ResponseModel> getAssets(Collection<String> sectors,
                                     Collection<Integer> typesOfOwnerships,
                                     Collection<String> industrialClassifications,
                                     Collection<Integer> years)

Fetch all assets data which match the input constraints.

Parameters:

sectors - the sectors

typesOfOwnerships - the types of ownerships

industrialClassifications - the industrial classifications

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