com.github.dannil.scbjavaclient.client.educationandresearch.folkhighschoolstatistics

Class EducationAndResearchFolkHighSchoolStatisticsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.educationandresearch.folkhighschoolstatistics.EducationAndResearchFolkHighSchoolStatisticsClient

public class EducationAndResearchFolkHighSchoolStatisticsClient
extends AbstractClient

Client which handles education and research folk high school statistics data fetching.

Since:

2.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getParticipants() Fetch all participants in long folk high school courses data.
List<ResponseModel>	getParticipants(Collection<String> regions, Collection<String> sexes, Collection<String> typesOfCourses, Collection<Integer> years) Fetch all participants in long folk high school courses 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

EducationAndResearchFolkHighSchoolStatisticsClient

public EducationAndResearchFolkHighSchoolStatisticsClient()

Default constructor.

EducationAndResearchFolkHighSchoolStatisticsClient

public EducationAndResearchFolkHighSchoolStatisticsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getParticipants

public List<ResponseModel> getParticipants()

Fetch all participants in long folk high school courses data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getParticipants(Collection, Collection, Collection, Collection)

getParticipants

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

Fetch all participants in long folk high school courses data which match the input constraints.

Parameters:

regions - the regions

sexes - the sexes

typesOfCourses - the types of courses

years - the years

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