com.github.dannil.scbjavaclient.client.environment.landuse.planning

Class EnvironmentLandUsePlanningClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.landuse.planning.EnvironmentLandUsePlanningClient

public class EnvironmentLandUsePlanningClient
extends AbstractClient

Client which handles environment land use planning data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<Planning>	getPlanning() Fetch all planning data.
List<Planning>	getPlanning(Collection<String> regions, Collection<Integer> years) Fetch all planning data which match the input constraints.
String	getUrl() Returns the URL endpoint which this client represents.

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractClient

doGetRequest, doPostRequest, getLocale, getLocalizationLocale, getRootUrl, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnvironmentLandUsePlanningClient

public EnvironmentLandUsePlanningClient()

Default constructor.

EnvironmentLandUsePlanningClient

public EnvironmentLandUsePlanningClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getPlanning

public List<Planning> getPlanning()

Fetch all planning data.

Returns:

the planning data wrapped in a list of Planning objects

See Also:

getPlanning(Collection, Collection)

getPlanning

public List<Planning> getPlanning(Collection<String> regions,
                                  Collection<Integer> years)

Fetch all planning data which match the input constraints.

Parameters:

regions - the regions to fetch data for

years - the years to fetch data for

Returns:

the planning data wrapped in a list of Planning objects

getUrl

public String 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