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

Class LivingConditionsFamiliesLegalGuardiansClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.livingconditions.families.legalguardians.LivingConditionsFamiliesLegalGuardiansClient

public class LivingConditionsFamiliesLegalGuardiansClient
extends AbstractClient

Client which handles living conditions families legal guardians data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<LegalGuardians>	getLegalGuardians() Fetch all legal guardians data.
List<LegalGuardians>	getLegalGuardians(Collection<String> sexes, Collection<String> caregivers, Collection<String> familyTypes, Collection<Integer> years) Fetch all legal guardians 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

LivingConditionsFamiliesLegalGuardiansClient

public LivingConditionsFamiliesLegalGuardiansClient()

Default constructor.

LivingConditionsFamiliesLegalGuardiansClient

public LivingConditionsFamiliesLegalGuardiansClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getLegalGuardians

public List<LegalGuardians> getLegalGuardians()

Fetch all legal guardians data.

Returns:

the legal guardians data wrapped in a list of LegalGuardians objects

See Also:

getLegalGuardians(Collection, Collection, Collection, Collection)

getLegalGuardians

public List<LegalGuardians> getLegalGuardians(Collection<String> sexes,
                                              Collection<String> caregivers,
                                              Collection<String> familyTypes,
                                              Collection<Integer> years)

Fetch all legal guardians data which match the input constraints.

Parameters:

sexes - the sexes

caregivers - the caregivers

familyTypes - the family types

years - the years

Returns:

the legal guardians data wrapped in a list of LegalGuardians 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