Package com.github.dannil.scbjavaclient.client.labourmarket.grosspay.aggregatewages

Class LabourMarketGrossPayAggregateWagesClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.labourmarket.grosspay.aggregatewages.LabourMarketGrossPayAggregateWagesClient

public class LabourMarketGrossPayAggregateWagesClient
extends AbstractClient

Client which handles labour market gross pay aggregate wages data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getGrossPay()	Fetch all gross pay data.
List<ResponseModel>	getGrossPay(Collection<String> counties, Collection<Integer> years)	Fetch all gross pay 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

LabourMarketGrossPayAggregateWagesClient

public LabourMarketGrossPayAggregateWagesClient()

Default constructor.

LabourMarketGrossPayAggregateWagesClient

public LabourMarketGrossPayAggregateWagesClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getGrossPay

public List<ResponseModel> getGrossPay()

Fetch all gross pay data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getGrossPay(Collection, Collection)

getGrossPay

public List<ResponseModel> getGrossPay(Collection<String> counties,
                                       Collection<Integer> years)

Fetch all gross pay data which match the input constraints.

Parameters:

counties - the counties

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