Package com.github.dannil.scbjavaclient.client.financialmarkets.shareholders.restoftheworld

Class FinancialMarketsShareholdersRestOfTheWorldClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.financialmarkets.shareholders.restoftheworld.FinancialMarketsShareholdersRestOfTheWorldClient

public class FinancialMarketsShareholdersRestOfTheWorldClient
extends AbstractClient

Client which handles financial markets shareholders rest of the world data fetching.

Since:

3.0.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getForeignOwnershipOfShares()	Fetch all foreign ownership of shares data.
List<ResponseModel>	getForeignOwnershipOfShares(Collection<String> countries, Collection<String> twoTimesPerYears)	Fetch all foreign ownership of shares 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

FinancialMarketsShareholdersRestOfTheWorldClient

public FinancialMarketsShareholdersRestOfTheWorldClient()

Default constructor.

FinancialMarketsShareholdersRestOfTheWorldClient

public FinancialMarketsShareholdersRestOfTheWorldClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getForeignOwnershipOfShares

public List<ResponseModel> getForeignOwnershipOfShares()

Fetch all foreign ownership of shares data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getForeignOwnershipOfShares(Collection, Collection)

getForeignOwnershipOfShares

public List<ResponseModel> getForeignOwnershipOfShares(Collection<String> countries,
                                                       Collection<String> twoTimesPerYears)

Fetch all foreign ownership of shares data which match the input constraints.

Parameters:

countries - the countries to fetch data for

twoTimesPerYears - the two times per 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