com.github.dannil.scbjavaclient.client.energy.monthlystatistics

Class EnergyMonthlyStatisticsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.energy.monthlystatistics.EnergyMonthlyStatisticsClient

public class EnergyMonthlyStatisticsClient
extends AbstractClient

Client which handles energy monthly statistics data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getDeliveriesOfLiquidFuels() Fetch all deliveries of liquid fuels data.
List<ResponseModel>	getDeliveriesOfLiquidFuels(Collection<Integer> commodities, Collection<String> userCategories, Collection<String> months) Fetch all deliveries of liquid fuels data which match the input constraints.
List<ResponseModel>	getDeliveriesOfOilProducts() Fetch all deliveries of oil products data.
List<ResponseModel>	getDeliveriesOfOilProducts(Collection<Integer> commodities, Collection<String> userCategories, Collection<String> months) Fetch all deliveries of oil products 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

EnergyMonthlyStatisticsClient

public EnergyMonthlyStatisticsClient()

Default constructor.

EnergyMonthlyStatisticsClient

public EnergyMonthlyStatisticsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getDeliveriesOfLiquidFuels

public List<ResponseModel> getDeliveriesOfLiquidFuels()

Fetch all deliveries of liquid fuels data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getDeliveriesOfLiquidFuels(Collection, Collection, Collection)

getDeliveriesOfLiquidFuels

public List<ResponseModel> getDeliveriesOfLiquidFuels(Collection<Integer> commodities,
                                                      Collection<String> userCategories,
                                                      Collection<String> months)

Fetch all deliveries of liquid fuels data which match the input constraints.

Parameters:

commodities - the commodities to fetch data for

userCategories - the user categories to fetch data for

months - the months to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getDeliveriesOfOilProducts

public List<ResponseModel> getDeliveriesOfOilProducts()

Fetch all deliveries of oil products data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getDeliveriesOfOilProducts(Collection, Collection, Collection)

getDeliveriesOfOilProducts

public List<ResponseModel> getDeliveriesOfOilProducts(Collection<Integer> commodities,
                                                      Collection<String> userCategories,
                                                      Collection<String> months)

Fetch all deliveries of oil products data which match the input constraints.

Parameters:

commodities - the commodities to fetch data for

userCategories - the user categories to fetch data for

months - the months to fetch data for

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