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

Class PricesAndConsumptionCCIFPIExcludingWageClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.pricesandconsumption.cci.fpiexcludingwage.PricesAndConsumptionCCIFPIExcludingWageClient

public class PricesAndConsumptionCCIFPIExcludingWageClient
extends AbstractClient

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

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

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

PricesAndConsumptionCCIFPIExcludingWageClient

public PricesAndConsumptionCCIFPIExcludingWageClient()

Default constructor.

PricesAndConsumptionCCIFPIExcludingWageClient

public PricesAndConsumptionCCIFPIExcludingWageClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getFactorPriceIndexForBuildings1968Months

public List<ResponseModel> getFactorPriceIndexForBuildings1968Months()

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

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getFactorPriceIndexForBuildings1968Months(Collection, Collection, Collection)

getFactorPriceIndexForBuildings1968Months

public List<ResponseModel> getFactorPriceIndexForBuildings1968Months(Collection<String> typesOfBuildings,
                                                                     Collection<String> typesOfExpenditures,
                                                                     Collection<String> months)

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

Parameters:

typesOfBuildings - the types of buildings

typesOfExpenditures - the types of expenditures

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getFactorPriceIndexForBuildings2015Months

public List<ResponseModel> getFactorPriceIndexForBuildings2015Months()

Fetch all factor price index for buildings (2015=100) months data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getFactorPriceIndexForBuildings2015Months(Collection, Collection, Collection)

getFactorPriceIndexForBuildings2015Months

public List<ResponseModel> getFactorPriceIndexForBuildings2015Months(Collection<String> typesOfBuildings,
                                                                     Collection<String> typesOfExpenditures,
                                                                     Collection<String> months)

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

Parameters:

typesOfBuildings - the types of buildings

typesOfExpenditures - the types of expenditures

months - the months

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