com.github.dannil.scbjavaclient.client.publicfinances.taxassessment

Class PublicFinancesTaxAssessmentClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.publicfinances.taxassessment.PublicFinancesTaxAssessmentClient

public class PublicFinancesTaxAssessmentClient
extends AbstractClient

Client which handles public finances tax assessment data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getAssessedAndTaxableEarnedIncome() Fetch all assessed and taxable earned income data.
List<ResponseModel>	getAssessedAndTaxableEarnedIncome(Collection<String> regions, Collection<Integer> years) Fetch all assessed and taxable earned income data which match the input constraints.
List<ResponseModel>	getAssessmentForNationalCapitalIncomeTax() Fetch all assessment for national capital income tax data.
List<ResponseModel>	getAssessmentForNationalCapitalIncomeTax(Collection<String> regions, Collection<Integer> years) Fetch all assessment for national capital income tax 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

PublicFinancesTaxAssessmentClient

public PublicFinancesTaxAssessmentClient()

Default constructor.

PublicFinancesTaxAssessmentClient

public PublicFinancesTaxAssessmentClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getAssessedAndTaxableEarnedIncome

public List<ResponseModel> getAssessedAndTaxableEarnedIncome()

Fetch all assessed and taxable earned income data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAssessedAndTaxableEarnedIncome(Collection, Collection)

getAssessedAndTaxableEarnedIncome

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

Fetch all assessed and taxable earned income data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getAssessmentForNationalCapitalIncomeTax

public List<ResponseModel> getAssessmentForNationalCapitalIncomeTax()

Fetch all assessment for national capital income tax data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAssessmentForNationalCapitalIncomeTax(Collection, Collection)

getAssessmentForNationalCapitalIncomeTax

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

Fetch all assessment for national capital income tax 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