com.github.dannil.scbjavaclient.client.environment.localitiesareasandpopulation.gainfullyemployedandworkplaces

Class EnvironmentLocalitiesAreasAndPopulationGainfullyEmployedAndWorkplacesClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.localitiesareasandpopulation.gainfullyemployedandworkplaces.EnvironmentLocalitiesAreasAndPopulationGainfullyEmployedAndWorkplacesClient

public class EnvironmentLocalitiesAreasAndPopulationGainfullyEmployedAndWorkplacesClient
extends AbstractClient

Client which handles environment localities areas and population gainfully employed and workplaces data fetching.

Since:

0.7.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getGainfullyEmployed() Fetch all gainfully employed 16+ years data.
List<ResponseModel>	getGainfullyEmployed(Collection<String> regions, Collection<Integer> sexes, Collection<Integer> years) Fetch all gainfully employed 16+ years data which match the input constraints.
List<ResponseModel>	getGainfullyEmployedAreas() Fetch all gainfully employed 16+ years areas data.
List<ResponseModel>	getGainfullyEmployedAreas(Collection<String> regions, Collection<String> typeOfAreas, Collection<Integer> years) Fetch all gainfully employed 16+ years areas data which match the input constraints.
List<ResponseModel>	getGainfullyEmployedWorkplaces() Fetch all gainfully employed 16+ years workplaces data.
List<ResponseModel>	getGainfullyEmployedWorkplaces(Collection<String> regions, Collection<Integer> years) Fetch all gainfully employed 16+ years workplaces 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, getLocale, getLocalizationLocale, getResponseModels, getResponseModels, getRootUrl, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnvironmentLocalitiesAreasAndPopulationGainfullyEmployedAndWorkplacesClient

public EnvironmentLocalitiesAreasAndPopulationGainfullyEmployedAndWorkplacesClient()

Default constructor.

EnvironmentLocalitiesAreasAndPopulationGainfullyEmployedAndWorkplacesClient

public EnvironmentLocalitiesAreasAndPopulationGainfullyEmployedAndWorkplacesClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getGainfullyEmployed

public List<ResponseModel> getGainfullyEmployed()

Fetch all gainfully employed 16+ years data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getGainfullyEmployed(Collection, Collection, Collection)

getGainfullyEmployed

public List<ResponseModel> getGainfullyEmployed(Collection<String> regions,
                                                Collection<Integer> sexes,
                                                Collection<Integer> years)

Fetch all gainfully employed 16+ years data which match the input constraints.

Parameters:

regions - the regions to fetch data for

sexes - the sexes to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getGainfullyEmployedWorkplaces

public List<ResponseModel> getGainfullyEmployedWorkplaces()

Fetch all gainfully employed 16+ years workplaces data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getGainfullyEmployedWorkplaces(Collection, Collection)

getGainfullyEmployedWorkplaces

public List<ResponseModel> getGainfullyEmployedWorkplaces(Collection<String> regions,
                                                          Collection<Integer> years)

Fetch all gainfully employed 16+ years workplaces data which match the input constraints.

Parameters:

regions - the regions to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getGainfullyEmployedAreas

public List<ResponseModel> getGainfullyEmployedAreas()

Fetch all gainfully employed 16+ years areas data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getGainfullyEmployedAreas(Collection, Collection, Collection)

getGainfullyEmployedAreas

public List<ResponseModel> getGainfullyEmployedAreas(Collection<String> regions,
                                                     Collection<String> typeOfAreas,
                                                     Collection<Integer> years)

Fetch all gainfully employed 16+ years areas data which match the input constraints.

Parameters:

regions - the regions to fetch data for

typeOfAreas - the type of areas to fetch data for

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