Package com.github.dannil.scbjavaclient.client.labourmarket.costindex

Class LabourMarketCostIndexClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.labourmarket.costindex.LabourMarketCostIndexClient

public class LabourMarketCostIndexClient
extends AbstractClient

Client which handles labour market cost index data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getCostIndexForManualWorkersLCI()	Fetch all cost index for manual workers (LCI) data.
List<ResponseModel>	getCostIndexForManualWorkersLCI(Collection<String> industrialClassifications, Collection<String> quarters)	Fetch all cost index for manual workers (LCI) data which match the input constraints.
List<ResponseModel>	getCostIndexForManualWorkersWAG()	Fetch all cost index for manual workers (WAG) data.
List<ResponseModel>	getCostIndexForManualWorkersWAG(Collection<String> industrialClassifications, Collection<String> quarters)	Fetch all cost index for manual workers (WAG) data which match the input constraints.
List<ResponseModel>	getCostIndexForNonManualWorkersLCI()	Fetch all cost index for non-manual workers (LCI) data.
List<ResponseModel>	getCostIndexForNonManualWorkersLCI(Collection<String> industrialClassifications, Collection<String> quarters)	Fetch all cost index for non-manual workers (LCI) data which match the input constraints.
List<ResponseModel>	getCostIndexForNonManualWorkersWAG()	Fetch all cost index for non-manual workers (WAG) data.
List<ResponseModel>	getCostIndexForNonManualWorkersWAG(Collection<String> industrialClassifications, Collection<String> quarters)	Fetch all cost index for non-manual workers (WAG) 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

LabourMarketCostIndexClient

public LabourMarketCostIndexClient()

Default constructor.

LabourMarketCostIndexClient

public LabourMarketCostIndexClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getCostIndexForManualWorkersLCI

public List<ResponseModel> getCostIndexForManualWorkersLCI()

Fetch all cost index for manual workers (LCI) data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getCostIndexForManualWorkersLCI(Collection, Collection)

getCostIndexForManualWorkersLCI

public List<ResponseModel> getCostIndexForManualWorkersLCI(Collection<String> industrialClassifications,
                                                           Collection<String> quarters)

Fetch all cost index for manual workers (LCI) data which match the input constraints.

Parameters:

industrialClassifications - the industrial classifications to fetch data for

quarters - the quarters to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getCostIndexForNonManualWorkersLCI

public List<ResponseModel> getCostIndexForNonManualWorkersLCI()

Fetch all cost index for non-manual workers (LCI) data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getCostIndexForNonManualWorkersLCI(Collection, Collection)

getCostIndexForNonManualWorkersLCI

public List<ResponseModel> getCostIndexForNonManualWorkersLCI(Collection<String> industrialClassifications,
                                                              Collection<String> quarters)

Fetch all cost index for non-manual workers (LCI) data which match the input constraints.

Parameters:

industrialClassifications - the industrial classifications to fetch data for

quarters - the quarters to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getCostIndexForManualWorkersWAG

public List<ResponseModel> getCostIndexForManualWorkersWAG()

Fetch all cost index for manual workers (WAG) data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getCostIndexForManualWorkersWAG(Collection, Collection)

getCostIndexForManualWorkersWAG

public List<ResponseModel> getCostIndexForManualWorkersWAG(Collection<String> industrialClassifications,
                                                           Collection<String> quarters)

Fetch all cost index for manual workers (WAG) data which match the input constraints.

Parameters:

industrialClassifications - the industrial classifications to fetch data for

quarters - the quarters to fetch data for

Returns:

the data wrapped in a list of ResponseModel

getCostIndexForNonManualWorkersWAG

public List<ResponseModel> getCostIndexForNonManualWorkersWAG()

Fetch all cost index for non-manual workers (WAG) data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getCostIndexForNonManualWorkersWAG(Collection, Collection)

getCostIndexForNonManualWorkersWAG

public List<ResponseModel> getCostIndexForNonManualWorkersWAG(Collection<String> industrialClassifications,
                                                              Collection<String> quarters)

Fetch all cost index for non-manual workers (WAG) data which match the input constraints.

Parameters:

industrialClassifications - the industrial classifications to fetch data for

quarters - the quarters 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