LivingConditionsClient (scb-java-client 3.0.0 API)

java.lang.Object
- com.github.dannil.scbjavaclient.client.AbstractClient
- - com.github.dannil.scbjavaclient.client.AbstractContainerClient
  - - com.github.dannil.scbjavaclient.client.livingconditions.LivingConditionsClient

public class LivingConditionsClient
extends AbstractContainerClient

Client which handles living conditions data fetching.

Since:: 0.2.0

Constructor Summary

Constructors
Constructor Description

LivingConditionsClient()
Default constructor.

LivingConditionsClient(Locale locale)
Overloaded constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LivingConditionsFamiliesClient`	`families()`	Retrieve the client for interacting with living conditions families data.
`URLEndpoint`	`getUrl()`	Returns the URL endpoint which this client represents.
`LivingConditionsSurveysClient`	`surveys()`	Retrieve the client for interacting with living conditions surveys data.

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractContainerClient
addClient, getClient, setLocale

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractClient
doGetRequest, doPostRequest, getCommunicationProtocol, getLocale, getLocalizationLocale, getResponseModels, getResponseModels, getRootUrl, setCommunicationProtocol, setLocalizationLocale

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LivingConditionsClient
```
public LivingConditionsClient()
```
    Default constructor. Initializes values and creates sub-clients.
  - LivingConditionsClient
```
public LivingConditionsClient(Locale locale)
```
    Overloaded constructor.
    
    Parameters:
    
    locale - the Locale for this client
- Method Detail
  - families
```
public LivingConditionsFamiliesClient families()
```
    Retrieve the client for interacting with living conditions families data.
    
    Returns:
    
    a client for living conditions families data
  - surveys
```
public LivingConditionsSurveysClient surveys()
```
    Retrieve the client for interacting with living conditions surveys data.
    
    Returns:
    
    a client for living conditions surveys data
  - 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