com.github.dannil.scbjavaclient.client.labourmarket.shorttermemployment.population

Class LabourMarketShortTermEmploymentPopulationClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.labourmarket.shorttermemployment.population.LabourMarketShortTermEmploymentPopulationClient

public class LabourMarketShortTermEmploymentPopulationClient
extends AbstractClient

Client which handles labour market short-term employment population data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getNumberOfEmployees() Fetch all number of employees data.
List<ResponseModel>	getNumberOfEmployees(Collection<String> regions, Collection<String> sectors, Collection<String> quarters) Fetch all number of employees 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

LabourMarketShortTermEmploymentPopulationClient

public LabourMarketShortTermEmploymentPopulationClient()

Default constructor.

LabourMarketShortTermEmploymentPopulationClient

public LabourMarketShortTermEmploymentPopulationClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getNumberOfEmployees

public List<ResponseModel> getNumberOfEmployees()

Fetch all number of employees data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNumberOfEmployees(Collection, Collection, Collection)

getNumberOfEmployees

public List<ResponseModel> getNumberOfEmployees(Collection<String> regions,
                                                Collection<String> sectors,
                                                Collection<String> quarters)

Fetch all number of employees data which match the input constraints.

Parameters:

regions - the regions

sectors - the sectors

quarters - the quarters

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