com.github.dannil.scbjavaclient.client.pricesandconsumption.bpi

Class PricesAndConsumptionBPIClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.pricesandconsumption.bpi.PricesAndConsumptionBPIClient

public class PricesAndConsumptionBPIClient
extends AbstractClient

Client which handles prices and consumption building price index (BPI) data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getBuildingPriceIndexForDwellingsQuarters() Fetch all building price index for dwellings (quarters) data.
List<ResponseModel>	getBuildingPriceIndexForDwellingsQuarters(Collection<String> typesOfBuildings, Collection<String> typesOfIndexes, Collection<String> quarters) Fetch all building price index for dwellings (quarters) data which match the input constraints.
List<ResponseModel>	getBuildingPriceIndexForDwellingsYears() Fetch all building price index for dwellings (years) data.
List<ResponseModel>	getBuildingPriceIndexForDwellingsYears(Collection<String> typesOfBuildings, Collection<String> typesOfIndexes, Collection<Integer> years) Fetch all building price index for dwellings (years) 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

PricesAndConsumptionBPIClient

public PricesAndConsumptionBPIClient()

Default constructor.

PricesAndConsumptionBPIClient

public PricesAndConsumptionBPIClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getBuildingPriceIndexForDwellingsQuarters

public List<ResponseModel> getBuildingPriceIndexForDwellingsQuarters()

Fetch all building price index for dwellings (quarters) data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getBuildingPriceIndexForDwellingsQuarters(Collection, Collection, Collection)

getBuildingPriceIndexForDwellingsQuarters

public List<ResponseModel> getBuildingPriceIndexForDwellingsQuarters(Collection<String> typesOfBuildings,
                                                                     Collection<String> typesOfIndexes,
                                                                     Collection<String> quarters)

Fetch all building price index for dwellings (quarters) data which match the input constraints.

Parameters:

typesOfBuildings - the types of buildings

typesOfIndexes - the types of indexes

quarters - the quarters

Returns:

the data wrapped in a list of ResponseModel objects

getBuildingPriceIndexForDwellingsYears

public List<ResponseModel> getBuildingPriceIndexForDwellingsYears()

Fetch all building price index for dwellings (years) data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getBuildingPriceIndexForDwellingsYears(Collection, Collection, Collection)

getBuildingPriceIndexForDwellingsYears

public List<ResponseModel> getBuildingPriceIndexForDwellingsYears(Collection<String> typesOfBuildings,
                                                                  Collection<String> typesOfIndexes,
                                                                  Collection<Integer> years)

Fetch all building price index for dwellings (years) data which match the input constraints.

Parameters:

typesOfBuildings - the types of buildings

typesOfIndexes - the types of indexes

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