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

Class FinancialMarketsShareholdersClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.AbstractContainerClient

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

public class FinancialMarketsShareholdersClient
extends AbstractContainerClient

Client which handles financial markets shareholders data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getForeignOwnershipOfShares()	Deprecated, for removal: This API element is subject to removal in a future version. table removed from API, use FinancialMarketsShareholdersRestOfTheWorldClient#getForeignOwnershipOfShares() instead
List<ResponseModel>	getForeignOwnershipOfShares(Collection<String> countries, Collection<String> twoTimesPerYears)	Deprecated, for removal: This API element is subject to removal in a future version. table removed from API, use FinancialMarketsShareholdersRestOfTheWorldClient#getForeignOwnershipOfShares(Collection, Collection) instead
List<ResponseModel>	getOwnershipOfShares()	Deprecated, for removal: This API element is subject to removal in a future version. table removed from API
List<ResponseModel>	getOwnershipOfShares(Collection<String> sectors, Collection<String> twoTimesPerYears)	Deprecated, for removal: This API element is subject to removal in a future version. table removed from API
List<ResponseModel>	getOwnershipOfSharesByMarketplace()	Deprecated, for removal: This API element is subject to removal in a future version. table removed from API, use FinancialMarketsShareholdersSwedishMarketplaceClient#getOwnershipOfSharesByMarketplace() instead
List<ResponseModel>	getOwnershipOfSharesByMarketplace(Collection<String> sectors, Collection<String> marketplaces, Collection<String> twoTimesPerYears)	Deprecated, for removal: This API element is subject to removal in a future version. table removed from API, use FinancialMarketsShareholdersSwedishMarketplaceClient#getOwnershipOfSharesByMarketplace(Collection, Collection, Collection) instead
List<ResponseModel>	getOwnershipOfSharesBySeries()	Deprecated, for removal: This API element is subject to removal in a future version. table removed from API, use FinancialMarketsShareholdersSwedishMarketplaceClient#getOwnershipOfSharesBySeries() instead
List<ResponseModel>	getOwnershipOfSharesBySeries(Collection<String> sectors, Collection<String> classesOfShares, Collection<String> twoTimesPerYears)	Deprecated, for removal: This API element is subject to removal in a future version. table removed from API, use FinancialMarketsShareholdersSwedishMarketplaceClient#getOwnershipOfSharesBySeries(Collection, Collection, Collection) instead
URLEndpoint	getUrl()	Returns the URL endpoint which this client represents.
FinancialMarketsShareholdersRestOfTheWorldClient	restOfTheWorld()	Retrieve the client for interacting with financial markets rest of the world data.
FinancialMarketsShareholdersSwedishMarketplaceClient	swedishMarketplace()	Retrieve the client for interacting with financial markets Swedish marketplace data.

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

addClient, getClient, setLocale

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

doGetRequest, doPostRequest, getCommunicationProtocol, getLocale, getLocalizationLocale, getResponseModels, getResponseModels, getRootUrl, setCommunicationProtocol, 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. Initializes values and creates sub-clients.

FinancialMarketsShareholdersClient

public FinancialMarketsShareholdersClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

swedishMarketplace

public FinancialMarketsShareholdersSwedishMarketplaceClient swedishMarketplace()

Retrieve the client for interacting with financial markets Swedish marketplace data.

Returns:

a client for financial markets Swedish marketplace data

restOfTheWorld

public FinancialMarketsShareholdersRestOfTheWorldClient restOfTheWorld()

Retrieve the client for interacting with financial markets rest of the world data.

Returns:

a client for financial markets rest of the world data

getOwnershipOfShares

@Deprecated(since="3.0.0",
            forRemoval=true)
public List<ResponseModel> getOwnershipOfShares()

Deprecated, for removal: This API element is subject to removal in a future version.

table removed from API

Fetch all ownership of shares data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getOwnershipOfShares(Collection, Collection)

getOwnershipOfShares

@Deprecated(since="3.0.0",
            forRemoval=true)
public List<ResponseModel> getOwnershipOfShares(Collection<String> sectors,
                                                Collection<String> twoTimesPerYears)

Deprecated, for removal: This API element is subject to removal in a future version.

table removed from API

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

Parameters:

sectors - the sectors to fetch data for

twoTimesPerYears - the two times per years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getOwnershipOfSharesByMarketplace

@Deprecated(since="3.0.0",
            forRemoval=true)
public List<ResponseModel> getOwnershipOfSharesByMarketplace()

Deprecated, for removal: This API element is subject to removal in a future version.

table removed from API, use FinancialMarketsShareholdersSwedishMarketplaceClient#getOwnershipOfSharesByMarketplace() instead

Fetch all ownership of shares by marketplace data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getOwnershipOfSharesByMarketplace(Collection, Collection, Collection)

getOwnershipOfSharesByMarketplace

@Deprecated(since="3.0.0",
            forRemoval=true)
public List<ResponseModel> getOwnershipOfSharesByMarketplace(Collection<String> sectors,
                                                             Collection<String> marketplaces,
                                                             Collection<String> twoTimesPerYears)

Deprecated, for removal: This API element is subject to removal in a future version.

table removed from API, use FinancialMarketsShareholdersSwedishMarketplaceClient#getOwnershipOfSharesByMarketplace(Collection, Collection, Collection) instead

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

Parameters:

sectors - the sectors to fetch data for

marketplaces - the marketplaces to fetch data for

twoTimesPerYears - the two times per years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getOwnershipOfSharesBySeries

@Deprecated(since="3.0.0",
            forRemoval=true)
public List<ResponseModel> getOwnershipOfSharesBySeries()

Deprecated, for removal: This API element is subject to removal in a future version.

table removed from API, use FinancialMarketsShareholdersSwedishMarketplaceClient#getOwnershipOfSharesBySeries() instead

Fetch all ownership of shares by series data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getOwnershipOfSharesBySeries(Collection, Collection, Collection)

getOwnershipOfSharesBySeries

@Deprecated(since="3.0.0",
            forRemoval=true)
public List<ResponseModel> getOwnershipOfSharesBySeries(Collection<String> sectors,
                                                        Collection<String> classesOfShares,
                                                        Collection<String> twoTimesPerYears)

Deprecated, for removal: This API element is subject to removal in a future version.

table removed from API, use FinancialMarketsShareholdersSwedishMarketplaceClient#getOwnershipOfSharesBySeries(Collection, Collection, Collection) instead

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

Parameters:

sectors - the sectors to fetch data for

classesOfShares - the classes of shares to fetch data for

twoTimesPerYears - the two times per years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getForeignOwnershipOfShares

@Deprecated(since="3.0.0",
            forRemoval=true)
public List<ResponseModel> getForeignOwnershipOfShares()

Deprecated, for removal: This API element is subject to removal in a future version.

table removed from API, use FinancialMarketsShareholdersRestOfTheWorldClient#getForeignOwnershipOfShares() instead

Fetch all foreign ownership of shares data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getForeignOwnershipOfShares(Collection, Collection)

getForeignOwnershipOfShares

@Deprecated(since="3.0.0",
            forRemoval=true)
public List<ResponseModel> getForeignOwnershipOfShares(Collection<String> countries,
                                                       Collection<String> twoTimesPerYears)

Deprecated, for removal: This API element is subject to removal in a future version.

table removed from API, use FinancialMarketsShareholdersRestOfTheWorldClient#getForeignOwnershipOfShares(Collection, Collection) instead

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