com.github.dannil.scbjavaclient.client.environment.protectednature.numberandarea

Class EnvironmentProtectedNatureNumberAndAreaClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.protectednature.numberandarea.EnvironmentProtectedNatureNumberAndAreaClient

public class EnvironmentProtectedNatureNumberAndAreaClient
extends AbstractClient

Client which handles environment protected nature number and area data fetching.

Since:

0.5.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getCultureReserves() Fetch all culture reserves data.
List<ResponseModel>	getCultureReserves(Collection<String> regions, Collection<Integer> years) Fetch all culture reserves data which match the input constraints.
List<ResponseModel>	getNatura2000Sites() Fetch all Natura 2000 sites data.
List<ResponseModel>	getNatura2000Sites(Collection<String> regions, Collection<Integer> years) Deprecated. use getNatura2000Sites(Collection, Collection, Collection) instead
List<ResponseModel>	getNatura2000Sites(Collection<String> regions, Collection<Integer> protectionTypes, Collection<Integer> years) Fetch all Natura 2000 sites data which match the input constraints.
List<ResponseModel>	getNaturalMonuments() Fetch all natural monuments data.
List<ResponseModel>	getNaturalMonuments(Collection<String> regions, Collection<Integer> years) Fetch all natural monuments data which match the input constraints.
List<ResponseModel>	getProtectedNature() Fetch all protected nature data.
List<ResponseModel>	getProtectedNature(Collection<String> regions, Collection<String> protectionTypes, Collection<Integer> years) Fetch all protected nature data which match the input constraints.
List<ResponseModel>	getSpeciesProtectedByLaw() Fetch all species protected by law data.
List<ResponseModel>	getSpeciesProtectedByLaw(Collection<String> regions, Collection<String> species, Collection<Integer> years) Fetch all species protected by law data which match the input constraints.
URLEndpoint	getUrl() Returns the URL endpoint which this client represents.
List<ResponseModel>	getWaterProtectionAreas() Fetch all water protection areas data.
List<ResponseModel>	getWaterProtectionAreas(Collection<String> regions, Collection<Integer> years) Fetch all water protection areas data which match the input constraints.
List<ResponseModel>	getWildlifeSanctuaries() Fetch all wildlife sanctuaries data.
List<ResponseModel>	getWildlifeSanctuaries(Collection<String> regions, Collection<Integer> years) Fetch all wildlife sanctuaries data which match the input constraints.

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

EnvironmentProtectedNatureNumberAndAreaClient

public EnvironmentProtectedNatureNumberAndAreaClient()

Default constructor.

EnvironmentProtectedNatureNumberAndAreaClient

public EnvironmentProtectedNatureNumberAndAreaClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getWildlifeSanctuaries

public List<ResponseModel> getWildlifeSanctuaries()

Fetch all wildlife sanctuaries data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getWildlifeSanctuaries(Collection, Collection)

getWildlifeSanctuaries

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

Fetch all wildlife sanctuaries data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getNatura2000Sites

public List<ResponseModel> getNatura2000Sites()

Fetch all Natura 2000 sites data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNatura2000Sites(Collection, Collection, Collection)

getNatura2000Sites

@Deprecated
public List<ResponseModel> getNatura2000Sites(Collection<String> regions,
                                                          Collection<Integer> years)

Deprecated. use getNatura2000Sites(Collection, Collection, Collection) instead

Fetch all Natura 2000 sites data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getNatura2000Sites

public List<ResponseModel> getNatura2000Sites(Collection<String> regions,
                                              Collection<Integer> protectionTypes,
                                              Collection<Integer> years)

Fetch all Natura 2000 sites data which match the input constraints.

Parameters:

regions - the regions

protectionTypes - the protection types

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getProtectedNature

public List<ResponseModel> getProtectedNature()

Fetch all protected nature data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getProtectedNature(Collection, Collection, Collection)

getProtectedNature

public List<ResponseModel> getProtectedNature(Collection<String> regions,
                                              Collection<String> protectionTypes,
                                              Collection<Integer> years)

Fetch all protected nature data which match the input constraints.

Parameters:

regions - the regions

protectionTypes - the protection types

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getSpeciesProtectedByLaw

public List<ResponseModel> getSpeciesProtectedByLaw()

Fetch all species protected by law data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getSpeciesProtectedByLaw(Collection, Collection, Collection)

getSpeciesProtectedByLaw

public List<ResponseModel> getSpeciesProtectedByLaw(Collection<String> regions,
                                                    Collection<String> species,
                                                    Collection<Integer> years)

Fetch all species protected by law data which match the input constraints.

Parameters:

regions - the regions

species - the species

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getCultureReserves

public List<ResponseModel> getCultureReserves()

Fetch all culture reserves data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getCultureReserves(Collection, Collection)

getCultureReserves

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

Fetch all culture reserves data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getNaturalMonuments

public List<ResponseModel> getNaturalMonuments()

Fetch all natural monuments data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNaturalMonuments(Collection, Collection)

getNaturalMonuments

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

Fetch all natural monuments data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getWaterProtectionAreas

public List<ResponseModel> getWaterProtectionAreas()

Fetch all water protection areas data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getWaterProtectionAreas(Collection, Collection)

getWaterProtectionAreas

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

Fetch all water protection areas data which match the input constraints.

Parameters:

regions - the regions

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