com.github.dannil.scbjavaclient.client.pricesandconsumption.cpi.pricebasicamount

Class PricesAndConsumptionCPIPriceBasicAmountClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.pricesandconsumption.cpi.pricebasicamount.PricesAndConsumptionCPIPriceBasicAmountClient

public class PricesAndConsumptionCPIPriceBasicAmountClient
extends AbstractClient

Client which handles prices and consumption Consumer Price Index (CPI) Price Basic Amount data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getIncreasedPriceBasicAmount() Fetch all increased price basic amount data.
List<ResponseModel>	getIncreasedPriceBasicAmount(Collection<Integer> years) Fetch all increased price basic amount data which match the input constraints.
List<ResponseModel>	getPriceBasicAmount() Fetch all price basic amount data.
List<ResponseModel>	getPriceBasicAmount(Collection<Integer> years) Fetch all price basic amount 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

PricesAndConsumptionCPIPriceBasicAmountClient

public PricesAndConsumptionCPIPriceBasicAmountClient()

Default constructor.

PricesAndConsumptionCPIPriceBasicAmountClient

public PricesAndConsumptionCPIPriceBasicAmountClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getPriceBasicAmount

public List<ResponseModel> getPriceBasicAmount()

Fetch all price basic amount data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPriceBasicAmount(Collection)

getPriceBasicAmount

public List<ResponseModel> getPriceBasicAmount(Collection<Integer> years)

Fetch all price basic amount data which match the input constraints.

Parameters:

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getIncreasedPriceBasicAmount

public List<ResponseModel> getIncreasedPriceBasicAmount()

Fetch all increased price basic amount data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getIncreasedPriceBasicAmount(Collection)

getIncreasedPriceBasicAmount

public List<ResponseModel> getIncreasedPriceBasicAmount(Collection<Integer> years)

Fetch all increased price basic amount data which match the input constraints.

Parameters:

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