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 Description LivingConditionsFamiliesSiblingsClient()Default constructor.LivingConditionsFamiliesSiblingsClient(Locale locale)Overloaded constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<ResponseModel>getSiblings()Fetch all siblings data.List<ResponseModel>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.URLEndpointgetUrl()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
-
-
-
-
Constructor Detail
-
LivingConditionsFamiliesSiblingsClient
public LivingConditionsFamiliesSiblingsClient()
Default constructor.
-
LivingConditionsFamiliesSiblingsClient
public LivingConditionsFamiliesSiblingsClient(Locale locale)
Overloaded constructor.
- Parameters:
locale- theLocalefor this client
-
-
Method Detail
-
getSiblings
public List<ResponseModel> getSiblings()
Fetch all siblings data.
- Returns:
- the data wrapped in a list of
ResponseModelobjects - See Also:
getSiblings(Collection, Collection, Collection, Collection, Collection)
-
getSiblings
public List<ResponseModel> 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 sexesages- the agessiblingsLivingAtHome- the siblings living at homefamilyTypes- the family typesyears- the years- Returns:
- the data wrapped in a list of
ResponseModelobjects
-
getUrl
public URLEndpoint getUrl()
Description copied from class:AbstractClientReturns the URL endpoint which this client represents.
- Specified by:
getUrlin classAbstractClient- Returns:
- the URL endpoint for this client
-
-