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

Class LivingConditionsFamiliesSiblingsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.livingconditions.families.siblings.LivingConditionsFamiliesSiblingsClient

public class LivingConditionsFamiliesSiblingsClient
extends AbstractClient

Client which handles living conditions families siblings data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<Siblings>	getSiblings() Fetch all siblings data.
List<Siblings>	getSiblings(Collection<String> sexes, Collection<String> ages, Collection<Integer> siblingsLivingAtHome, Collection<String> familyTypes, Collection<Integer> years) Fetch all siblings data which match the input constraints.
String	getUrl() Returns the URL endpoint which this client represents.

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractClient

doGetRequest, doPostRequest, getLocale, getLocalizationLocale, getRootUrl, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

LivingConditionsFamiliesSiblingsClient

public LivingConditionsFamiliesSiblingsClient()

Default constructor.

LivingConditionsFamiliesSiblingsClient

public LivingConditionsFamiliesSiblingsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getSiblings

public List<Siblings> getSiblings()

Fetch all siblings data.

Returns:

the siblings data wrapped in a list of Siblings objects

See Also:

getSiblings(Collection, Collection, Collection, Collection, Collection)

getSiblings

public List<Siblings> getSiblings(Collection<String> sexes,
                                  Collection<String> ages,
                                  Collection<Integer> siblingsLivingAtHome,
                                  Collection<String> familyTypes,
                                  Collection<Integer> years)

Fetch all siblings data which match the input constraints.

Parameters:

sexes - the sexes

ages - the ages

siblingsLivingAtHome - the siblings living at home

familyTypes - the family types

years - the years

Returns:

the siblings data wrapped in a list of Siblings objects

getUrl

public String 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