com.github.dannil.scbjavaclient.client.population.statistics.partnership

Class PopulationStatisticsPartnershipClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.partnership.PopulationStatisticsPartnershipClient

public class PopulationStatisticsPartnershipClient
extends AbstractClient

Client which handles population statistics partnership data fetching.

Since:

0.1.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getPartnership() Fetch all population partnership data.
List<ResponseModel>	getPartnership(Collection<String> regions, Collection<String> maritalStatuses, Collection<Integer> sexes, Collection<Integer> years) Fetch all population partnership data which match the input constraints.
List<ResponseModel>	getPartnershipChange() Fetch all population partnership change data.
List<ResponseModel>	getPartnershipChange(Collection<String> regions, Collection<String> maritalStatuses, Collection<Integer> sexes, Collection<Integer> years) Fetch all population partnership change 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

PopulationStatisticsPartnershipClient

public PopulationStatisticsPartnershipClient()

Default constructor.

PopulationStatisticsPartnershipClient

public PopulationStatisticsPartnershipClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getPartnership

public List<ResponseModel> getPartnership()

Fetch all population partnership data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPartnership(Collection, Collection, Collection, Collection)

getPartnership

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

Fetch all population partnership data which match the input constraints.

Parameters:

regions - the regions to fetch data for

maritalStatuses - the marital statuses 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

getPartnershipChange

public List<ResponseModel> getPartnershipChange()

Fetch all population partnership change data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPartnershipChange(Collection, Collection, Collection, Collection)

getPartnershipChange

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

Fetch all population partnership change data which match the input constraints.

Parameters:

regions - the regions to fetch data for

maritalStatuses - the marital statuses 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

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