Package com.github.dannil.scbjavaclient.client.pricesandconsumption.cci.fpiincludingwage

Class PricesAndConsumptionCCIFPIIncludingWageClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.pricesandconsumption.cci.fpiincludingwage.PricesAndConsumptionCCIFPIIncludingWageClient

public class PricesAndConsumptionCCIFPIIncludingWageClient
extends AbstractClient

Client which handles prices and consumption construction cost index (CCI) factor price index (FPI) including wage data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getFactorPriceIndexForBuildings1968Years()	Fetch all factor price index for buildings (1968=100) years data.
List<ResponseModel>	getFactorPriceIndexForBuildings1968Years(Collection<String> typesOfBuildings, Collection<String> typesOfExpenditures, Collection<Integer> years)	Fetch all factor price index for buildings (1968=100) years data which match the input constraints.
List<ResponseModel>	getFactorPriceIndexForBuildings2004Years()	Fetch all factor price index for buildings (2004=100) years data.
List<ResponseModel>	getFactorPriceIndexForBuildings2004Years(Collection<String> typesOfBuildings, Collection<String> typesOfExpenditures, Collection<Integer> years)	Fetch all factor price index for buildings (2004=100) 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

PricesAndConsumptionCCIFPIIncludingWageClient

public PricesAndConsumptionCCIFPIIncludingWageClient()

Default constructor.

PricesAndConsumptionCCIFPIIncludingWageClient

public PricesAndConsumptionCCIFPIIncludingWageClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getFactorPriceIndexForBuildings1968Years

public List<ResponseModel> getFactorPriceIndexForBuildings1968Years()

Fetch all factor price index for buildings (1968=100) years data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getFactorPriceIndexForBuildings1968Years(Collection, Collection, Collection)

getFactorPriceIndexForBuildings1968Years

public List<ResponseModel> getFactorPriceIndexForBuildings1968Years(Collection<String> typesOfBuildings,
                                                                    Collection<String> typesOfExpenditures,
                                                                    Collection<Integer> years)

Fetch all factor price index for buildings (1968=100) years data which match the input constraints.

Parameters:

typesOfBuildings - the types of buildings

typesOfExpenditures - the types of expenditures

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getFactorPriceIndexForBuildings2004Years

public List<ResponseModel> getFactorPriceIndexForBuildings2004Years()

Fetch all factor price index for buildings (2004=100) years data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getFactorPriceIndexForBuildings2004Years(Collection, Collection, Collection)

getFactorPriceIndexForBuildings2004Years

public List<ResponseModel> getFactorPriceIndexForBuildings2004Years(Collection<String> typesOfBuildings,
                                                                    Collection<String> typesOfExpenditures,
                                                                    Collection<Integer> years)

Fetch all factor price index for buildings (2004=100) years data which match the input constraints.

Parameters:

typesOfBuildings - the types of buildings

typesOfExpenditures - the types of expenditures

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