Package com.github.dannil.scbjavaclient.client.environment.waste

Class EnvironmentWasteClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.waste.EnvironmentWasteClient

public class EnvironmentWasteClient
extends AbstractClient

Client which handles environment waste data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getGeneratedWaste()	Fetch all generated waste data.
List<ResponseModel>	getGeneratedWaste(Collection<String> properties, Collection<String> industrialClassification, Collection<String> wasteCategories, Collection<Integer> years)	Fetch all generated waste data which match the input constraints.
List<ResponseModel>	getTreatedWaste()	Fetch all treated waste data.
List<ResponseModel>	getTreatedWaste(Collection<Integer> treatmentCategories, Collection<String> wasteCategories, Collection<Integer> years)	Fetch all treated waste 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

EnvironmentWasteClient

public EnvironmentWasteClient()

Default constructor.

EnvironmentWasteClient

public EnvironmentWasteClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getGeneratedWaste

public List<ResponseModel> getGeneratedWaste()

Fetch all generated waste data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getGeneratedWaste(Collection, Collection, Collection, Collection)

getGeneratedWaste

public List<ResponseModel> getGeneratedWaste(Collection<String> properties,
                                             Collection<String> industrialClassification,
                                             Collection<String> wasteCategories,
                                             Collection<Integer> years)

Fetch all generated waste data which match the input constraints.

Parameters:

properties - the properties to fetch data for

industrialClassification - the industrial classifications to fetch data for

wasteCategories - the waste categories to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getTreatedWaste

public List<ResponseModel> getTreatedWaste()

Fetch all treated waste data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getTreatedWaste(Collection, Collection, Collection)

getTreatedWaste

public List<ResponseModel> getTreatedWaste(Collection<Integer> treatmentCategories,
                                           Collection<String> wasteCategories,
                                           Collection<Integer> years)

Fetch all treated waste data which match the input constraints.

Parameters:

treatmentCategories - the treatment categories to fetch data for

wasteCategories - the waste categories to fetch data for

years - the years to fetch data for

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