com.github.dannil.scbjavaclient.client.businessactivities.productionindex

Class BusinessActivitiesProductionIndexClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.businessactivities.productionindex.BusinessActivitiesProductionIndexClient

public class BusinessActivitiesProductionIndexClient
extends AbstractClient

Client which handles business activities production index data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getBusinessProductionIndex() Fetch all business production index data.
List<ResponseModel>	getBusinessProductionIndex(Collection<String> industrialClassifications, Collection<String> months) Fetch all business production index 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

BusinessActivitiesProductionIndexClient

public BusinessActivitiesProductionIndexClient()

Default constructor.

BusinessActivitiesProductionIndexClient

public BusinessActivitiesProductionIndexClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getBusinessProductionIndex

public List<ResponseModel> getBusinessProductionIndex()

Fetch all business production index data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getBusinessProductionIndex(Collection, Collection)

getBusinessProductionIndex

public List<ResponseModel> getBusinessProductionIndex(Collection<String> industrialClassifications,
                                                      Collection<String> months)

Fetch all business production index data which match the input constraints.

Parameters:

industrialClassifications - the industrial classifications

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