Package com.github.dannil.scbjavaclient.client.agriculture.holdings

Class AgricultureHoldingsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.agriculture.holdings.AgricultureHoldingsClient

public class AgricultureHoldingsClient
extends AbstractClient

Client which handles agriculture holdings data fetching.

Since:

0.4.0

Constructor Summary

Constructors

Constructor	Description
AgricultureHoldingsClient()	Default constructor.
AgricultureHoldingsClient(Locale locale)	Overloaded constructor.

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getAgriculturalEnterprisesByCountyAndJuridicalForm()	Fetch all agricultural enterprises by county and juridical form data.
List<ResponseModel>	getAgriculturalEnterprisesByCountyAndJuridicalForm(Collection<String> regions, Collection<String> typesOfHoldings, Collection<Integer> years)	Fetch all agricultural enterprises by county and juridical form data which match the input constraints.
List<ResponseModel>	getAgriculturalEnterprisesByCountyAndSizeClass()	Fetch all agricultural enterprises by county and size class data.
List<ResponseModel>	getAgriculturalEnterprisesByCountyAndSizeClass(Collection<String> regions, Collection<String> sizeClasses, Collection<Integer> years)	Fetch all agricultural enterprises by county and size class data which match the input constraints.
List<ResponseModel>	getAgriculturalEnterprisesByMunicipalityAndSizeClass()	Fetch all agricultural enterprises by municipality and size class data.
List<ResponseModel>	getAgriculturalEnterprisesByMunicipalityAndSizeClass(Collection<String> regions, Collection<String> sizeClasses, Collection<Integer> years)	Fetch all agricultural enterprises by municipality and size class 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

AgricultureHoldingsClient

public AgricultureHoldingsClient()

Default constructor.

AgricultureHoldingsClient

public AgricultureHoldingsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getAgriculturalEnterprisesByMunicipalityAndSizeClass

public List<ResponseModel> getAgriculturalEnterprisesByMunicipalityAndSizeClass()

Fetch all agricultural enterprises by municipality and size class data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAgriculturalEnterprisesByMunicipalityAndSizeClass(Collection, Collection, Collection)

getAgriculturalEnterprisesByMunicipalityAndSizeClass

public List<ResponseModel> getAgriculturalEnterprisesByMunicipalityAndSizeClass(Collection<String> regions,
                                                                                Collection<String> sizeClasses,
                                                                                Collection<Integer> years)

Fetch all agricultural enterprises by municipality and size class data which match the input constraints.

Parameters:

regions - the regions

sizeClasses - the size classes

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getAgriculturalEnterprisesByCountyAndSizeClass

public List<ResponseModel> getAgriculturalEnterprisesByCountyAndSizeClass()

Fetch all agricultural enterprises by county and size class data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAgriculturalEnterprisesByCountyAndSizeClass(Collection, Collection, Collection)

getAgriculturalEnterprisesByCountyAndSizeClass

public List<ResponseModel> getAgriculturalEnterprisesByCountyAndSizeClass(Collection<String> regions,
                                                                          Collection<String> sizeClasses,
                                                                          Collection<Integer> years)

Fetch all agricultural enterprises by county and size class data which match the input constraints.

Parameters:

regions - the regions

sizeClasses - the size classes

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getAgriculturalEnterprisesByCountyAndJuridicalForm

public List<ResponseModel> getAgriculturalEnterprisesByCountyAndJuridicalForm()

Fetch all agricultural enterprises by county and juridical form data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAgriculturalEnterprisesByCountyAndJuridicalForm(Collection, Collection, Collection)

getAgriculturalEnterprisesByCountyAndJuridicalForm

public List<ResponseModel> getAgriculturalEnterprisesByCountyAndJuridicalForm(Collection<String> regions,
                                                                              Collection<String> typesOfHoldings,
                                                                              Collection<Integer> years)

Fetch all agricultural enterprises by county and juridical form data which match the input constraints.

Parameters:

regions - the regions

typesOfHoldings - the types of holdings

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