com.github.dannil.scbjavaclient.client.agriculture.livestock

Class AgricultureLivestockClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.agriculture.livestock.AgricultureLivestockClient

public class AgricultureLivestockClient
extends AbstractClient

Client which handles agriculture livestock data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getLivestockByCounty() Fetch all livestock by county data.
List<ResponseModel>	getLivestockByCounty(Collection<String> regions, Collection<String> typesOfAnimals, Collection<Integer> years) Fetch all livestock by county data which match the input constraints.
List<ResponseModel>	getLivestockByMunicipality() Fetch all livestock by municipality data.
List<ResponseModel>	getLivestockByMunicipality(Collection<String> regions, Collection<String> typesOfAnimals, Collection<Integer> years) Fetch all livestock by municipality 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

AgricultureLivestockClient

public AgricultureLivestockClient()

Default constructor.

AgricultureLivestockClient

public AgricultureLivestockClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getLivestockByMunicipality

public List<ResponseModel> getLivestockByMunicipality()

Fetch all livestock by municipality data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLivestockByMunicipality(Collection, Collection, Collection)

getLivestockByMunicipality

public List<ResponseModel> getLivestockByMunicipality(Collection<String> regions,
                                                      Collection<String> typesOfAnimals,
                                                      Collection<Integer> years)

Fetch all livestock by municipality data which match the input constraints.

Parameters:

regions - the regions

typesOfAnimals - the types of animals

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getLivestockByCounty

public List<ResponseModel> getLivestockByCounty()

Fetch all livestock by county data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLivestockByCounty(Collection, Collection, Collection)

getLivestockByCounty

public List<ResponseModel> getLivestockByCounty(Collection<String> regions,
                                                Collection<String> typesOfAnimals,
                                                Collection<Integer> years)

Fetch all livestock by county data which match the input constraints.

Parameters:

regions - the regions

typesOfAnimals - the types of animals

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