Package com.github.dannil.scbjavaclient.client.financialmarkets.enterprises

Class FinancialMarketsEnterprisesClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.financialmarkets.enterprises.FinancialMarketsEnterprisesClient

public class FinancialMarketsEnterprisesClient
extends AbstractClient

Client which handles financial markets enterprises data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getBalanceSheet()	Fetch all balance sheet data.
List<ResponseModel>	getBalanceSheet(Collection<String> institutes, Collection<String> items, Collection<Integer> years)	Fetch all balance sheet data which match the input constraints.
List<ResponseModel>	getIncomeStatements()	Fetch all income statements data.
List<ResponseModel>	getIncomeStatements(Collection<String> institutes, Collection<String> items, Collection<Integer> years)	Fetch all income statements 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

FinancialMarketsEnterprisesClient

public FinancialMarketsEnterprisesClient()

Default constructor.

FinancialMarketsEnterprisesClient

public FinancialMarketsEnterprisesClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getIncomeStatements

public List<ResponseModel> getIncomeStatements()

Fetch all income statements data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getIncomeStatements(Collection, Collection, Collection)

getIncomeStatements

public List<ResponseModel> getIncomeStatements(Collection<String> institutes,
                                               Collection<String> items,
                                               Collection<Integer> years)

Fetch all income statements data which match the input constraints.

Parameters:

institutes - the institutes

items - the items

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getBalanceSheet

public List<ResponseModel> getBalanceSheet()

Fetch all balance sheet data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getBalanceSheet(Collection, Collection, Collection)

getBalanceSheet

public List<ResponseModel> getBalanceSheet(Collection<String> institutes,
                                           Collection<String> items,
                                           Collection<Integer> years)

Fetch all balance sheet data which match the input constraints.

Parameters:

institutes - the institutes

items - the items

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