Package com.github.dannil.scbjavaclient.client.pricesandconsumption.cpi.cpifct

Class PricesAndConsumptionCPICPIFCTClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.pricesandconsumption.cpi.cpifct.PricesAndConsumptionCPICPIFCTClient

public class PricesAndConsumptionCPICPIFCTClient
extends AbstractClient

Client which handles prices and consumption Consumer Price Index (CPI) with fixed interest rate and at constant taxes (CPIF-CT) data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getFixedInterestRateAnnualChanges()	Fetch all fixed interest rate and at constant taxes (CPIF-CT) annual changes data.
List<ResponseModel>	getFixedInterestRateAnnualChanges(Collection<String> months)	Fetch all fixed interest rate and at constant taxes (CPIF-CT) annual changes data which match the input constraints.
List<ResponseModel>	getFixedInterestRateMonthlyChanges()	Fetch all fixed interest rate and at constant taxes (CPIF-CT) monthly changes data.
List<ResponseModel>	getFixedInterestRateMonthlyChanges(Collection<String> months)	Fetch all fixed interest rate and at constant taxes (CPIF-CT) monthly changes 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

PricesAndConsumptionCPICPIFCTClient

public PricesAndConsumptionCPICPIFCTClient()

Default constructor.

PricesAndConsumptionCPICPIFCTClient

public PricesAndConsumptionCPICPIFCTClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getFixedInterestRateMonthlyChanges

public List<ResponseModel> getFixedInterestRateMonthlyChanges()

Fetch all fixed interest rate and at constant taxes (CPIF-CT) monthly changes data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getFixedInterestRateMonthlyChanges(Collection)

getFixedInterestRateMonthlyChanges

public List<ResponseModel> getFixedInterestRateMonthlyChanges(Collection<String> months)

Fetch all fixed interest rate and at constant taxes (CPIF-CT) monthly changes data which match the input constraints.

Parameters:

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getFixedInterestRateAnnualChanges

public List<ResponseModel> getFixedInterestRateAnnualChanges()

Fetch all fixed interest rate and at constant taxes (CPIF-CT) annual changes data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getFixedInterestRateAnnualChanges(Collection)

getFixedInterestRateAnnualChanges

public List<ResponseModel> getFixedInterestRateAnnualChanges(Collection<String> months)

Fetch all fixed interest rate and at constant taxes (CPIF-CT) annual changes data which match the input constraints.

Parameters:

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