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

Class FinancialMarketsShareholdersClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.financialmarkets.shareholders.FinancialMarketsShareholdersClient

public class FinancialMarketsShareholdersClient
extends AbstractClient

Client which handles financial markets shareholders data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ForeignOwnershipOfShares>	getForeignOwnershipOfShares() Fetch all foreign ownership of shares data.
List<ForeignOwnershipOfShares>	getForeignOwnershipOfShares(Collection<String> countries, Collection<String> halfYears) Fetch all foreign ownership of shares data which match the input constraints.
List<OwnershipOfShares>	getOwnershipOfShares() Fetch all ownership of shares data.
List<OwnershipOfShares>	getOwnershipOfShares(Collection<String> sectors, Collection<String> halfYears) Fetch all ownership of shares data which match the input constraints.
List<OwnershipOfSharesByMarketplace>	getOwnershipOfSharesByMarketplace() Fetch all ownership of shares by marketplace data.
List<OwnershipOfSharesByMarketplace>	getOwnershipOfSharesByMarketplace(Collection<String> sectors, Collection<String> marketplaces, Collection<String> halfYears) Fetch all ownership of shares by marketplace data which match the input constraints.
List<OwnershipOfSharesBySeries>	getOwnershipOfSharesBySeries() Fetch all ownership of shares by series data.
List<OwnershipOfSharesBySeries>	getOwnershipOfSharesBySeries(Collection<String> sectors, Collection<String> series, Collection<String> halfYears) Fetch all ownership of shares by series data which match the input constraints.
String	getUrl() Returns the URL endpoint which this client represents.

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractClient

doGetRequest, doPostRequest, getLocale, getLocalizationLocale, getRootUrl, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FinancialMarketsShareholdersClient

public FinancialMarketsShareholdersClient()

Default constructor.

FinancialMarketsShareholdersClient

public FinancialMarketsShareholdersClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getOwnershipOfShares

public List<OwnershipOfShares> getOwnershipOfShares()

Fetch all ownership of shares data.

Returns:

the ownership of shares data wrapped in a list of OwnershipOfShares objects

See Also:

getOwnershipOfShares(Collection, Collection)

getOwnershipOfShares

public List<OwnershipOfShares> getOwnershipOfShares(Collection<String> sectors,
                                                    Collection<String> halfYears)

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

Parameters:

sectors - the sectors to fetch data for

halfYears - the half years to fetch data for

Returns:

the ownership of shares data wrapped in a list of OwnershipOfShares objects

getOwnershipOfSharesByMarketplace

public List<OwnershipOfSharesByMarketplace> getOwnershipOfSharesByMarketplace()

Fetch all ownership of shares by marketplace data.

Returns:

the ownership of shares by marketplace data wrapped in a list of OwnershipOfSharesByMarketplace objects

See Also:

getOwnershipOfSharesByMarketplace(Collection, Collection, Collection)

getOwnershipOfSharesByMarketplace

public List<OwnershipOfSharesByMarketplace> getOwnershipOfSharesByMarketplace(Collection<String> sectors,
                                                                              Collection<String> marketplaces,
                                                                              Collection<String> halfYears)

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

Parameters:

sectors - the sectors to fetch data for

halfYears - the half years to fetch data for

marketplaces - the marketplaces to fetch data for

Returns:

the ownership of shares by marketplace data wrapped in a list of OwnershipOfSharesByMarketplace objects

getOwnershipOfSharesBySeries

public List<OwnershipOfSharesBySeries> getOwnershipOfSharesBySeries()

Fetch all ownership of shares by series data.

Returns:

the ownership of of shares by series data wrapped in a list of OwnershipOfSharesBySeries objects

See Also:

getOwnershipOfSharesBySeries(Collection, Collection, Collection)

getOwnershipOfSharesBySeries

public List<OwnershipOfSharesBySeries> getOwnershipOfSharesBySeries(Collection<String> sectors,
                                                                    Collection<String> series,
                                                                    Collection<String> halfYears)

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

Parameters:

sectors - the sectors to fetch data for

halfYears - the half years to fetch data for

series - the series to fetch data for

Returns:

the ownership of shares by series data wrapped in a list of OwnershipOfSharesBySeries objects

getForeignOwnershipOfShares

public List<ForeignOwnershipOfShares> getForeignOwnershipOfShares()

Fetch all foreign ownership of shares data.

Returns:

the foreign ownership of shares data wrapped in a list of ForeignOwnershipOfShares objects

See Also:

getForeignOwnershipOfShares(Collection, Collection)

getForeignOwnershipOfShares

public List<ForeignOwnershipOfShares> getForeignOwnershipOfShares(Collection<String> countries,
                                                                  Collection<String> halfYears)

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

Parameters:

countries - the countries to fetch data for

halfYears - the half years to fetch data for

Returns:

the foreign ownership of shares data wrapped in a list of ForeignOwnershipOfShares objects

getUrl

public String 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