com.github.dannil.scbjavaclient.client.livingconditions.families.housing

Class LivingConditionsFamiliesHousingClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.livingconditions.families.housing.LivingConditionsFamiliesHousingClient

public class LivingConditionsFamiliesHousingClient
extends AbstractClient

Client which handles living conditions families housing data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getHousing() Fetch all housing data.
List<ResponseModel>	getHousing(Collection<String> sexes, Collection<String> ages, Collection<String> housingTypes, Collection<String> familyTypes, Collection<String> backgrounds, Collection<Integer> parentIncomes, Collection<Integer> years) Fetch all housing 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

LivingConditionsFamiliesHousingClient

public LivingConditionsFamiliesHousingClient()

Default constructor.

LivingConditionsFamiliesHousingClient

public LivingConditionsFamiliesHousingClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getHousing

public List<ResponseModel> getHousing()

Fetch all housing data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getHousing(Collection, Collection, Collection, Collection, Collection, Collection, Collection)

getHousing

public List<ResponseModel> getHousing(Collection<String> sexes,
                                      Collection<String> ages,
                                      Collection<String> housingTypes,
                                      Collection<String> familyTypes,
                                      Collection<String> backgrounds,
                                      Collection<Integer> parentIncomes,
                                      Collection<Integer> years)

Fetch all housing data which match the input constraints.

Parameters:

sexes - the sexes

ages - the ages

housingTypes - the housing types

familyTypes - the family types

backgrounds - the backgrounds

parentIncomes - the parent incomes

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