Package com.github.dannil.scbjavaclient.client.population.name.registeredpersons

Class PopulationNameRegisteredPersonsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.name.registeredpersons.PopulationNameRegisteredPersonsClient

public class PopulationNameRegisteredPersonsClient
extends AbstractClient

Client which handles population name registered persons data fetching.

Since:

0.5.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getFirstNamesNormallyUsed()	Fetch all first names normally used data.
List<ResponseModel>	getFirstNamesNormallyUsed(Collection<String> firstnames, Collection<Integer> years)	Fetch all first names normally used 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

PopulationNameRegisteredPersonsClient

public PopulationNameRegisteredPersonsClient()

Default constructor.

PopulationNameRegisteredPersonsClient

public PopulationNameRegisteredPersonsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getFirstNamesNormallyUsed

public List<ResponseModel> getFirstNamesNormallyUsed()

Fetch all first names normally used data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getFirstNamesNormallyUsed(Collection, Collection)

getFirstNamesNormallyUsed

public List<ResponseModel> getFirstNamesNormallyUsed(Collection<String> firstnames,
                                                     Collection<Integer> years)

Fetch all first names normally used data which match the input constraints.

Parameters:

firstnames - the firstnames

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