com.github.dannil.scbjavaclient.client.pricesandconsumption.purchasingpowerparities

Class PricesAndConsumptionPurchasingPowerParitiesClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.pricesandconsumption.purchasingpowerparities.PricesAndConsumptionPurchasingPowerParitiesClient

public class PricesAndConsumptionPurchasingPowerParitiesClient
extends AbstractClient

Client which handles prices and consumption purchasing power parities data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getExtrapolatedPriceLevelIndices() Fetch all extrapolated price level indices data.
List<ResponseModel>	getExtrapolatedPriceLevelIndices(Collection<String> countryGroups, Collection<Integer> years) Fetch all extrapolated price level indices data which match the input constraints.
List<ResponseModel>	getPurchasingPowerParities() Fetch all purchasing power parities data.
List<ResponseModel>	getPurchasingPowerParities(Collection<String> countries, Collection<String> esaClassifications, Collection<Integer> years) Fetch all purchasing power parities 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

PricesAndConsumptionPurchasingPowerParitiesClient

public PricesAndConsumptionPurchasingPowerParitiesClient()

Default constructor.

PricesAndConsumptionPurchasingPowerParitiesClient

public PricesAndConsumptionPurchasingPowerParitiesClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getExtrapolatedPriceLevelIndices

public List<ResponseModel> getExtrapolatedPriceLevelIndices()

Fetch all extrapolated price level indices data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getExtrapolatedPriceLevelIndices(Collection, Collection)

getExtrapolatedPriceLevelIndices

public List<ResponseModel> getExtrapolatedPriceLevelIndices(Collection<String> countryGroups,
                                                            Collection<Integer> years)

Fetch all extrapolated price level indices data which match the input constraints.

Parameters:

countryGroups - the country groups

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getPurchasingPowerParities

public List<ResponseModel> getPurchasingPowerParities()

Fetch all purchasing power parities data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPurchasingPowerParities(Collection, Collection, Collection)

getPurchasingPowerParities

public List<ResponseModel> getPurchasingPowerParities(Collection<String> countries,
                                                      Collection<String> esaClassifications,
                                                      Collection<Integer> years)

Fetch all purchasing power parities data which match the input constraints.

Parameters:

countries - the countries

esaClassifications - the ESA 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