com.github.dannil.scbjavaclient.client.financialmarkets.balanceofpayments.payments

Class FinancialMarketsBalanceOfPaymentsPaymentsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.financialmarkets.balanceofpayments.payments.FinancialMarketsBalanceOfPaymentsPaymentsClient

public class FinancialMarketsBalanceOfPaymentsPaymentsClient
extends AbstractClient

Client which handles financial markets balance of payments payments data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getCurrentAccountsQuarters() Fetch all current accounts quarters data.
List<ResponseModel>	getCurrentAccountsQuarters(Collection<String> countryGroups, Collection<String> exportsAndImports, Collection<String> items, Collection<String> quarters) Fetch all current accounts quarters data which match the input constraints.
List<ResponseModel>	getCurrentAccountsYears() Fetch all current accounts years data.
List<ResponseModel>	getCurrentAccountsYears(Collection<String> countryGroups, Collection<String> exportsAndImports, Collection<String> items, Collection<Integer> years) Fetch all current accounts years data which match the input constraints.
List<ResponseModel>	getFinancialAccountsQuarters() Fetch all financial accounts quarters data.
List<ResponseModel>	getFinancialAccountsQuarters(Collection<String> typesOfInvestments, Collection<String> items, Collection<String> quarters) Fetch all financial accounts quarters data which match the input constraints.
List<ResponseModel>	getFinancialAccountsYears() Fetch all financial accounts years data.
List<ResponseModel>	getFinancialAccountsYears(Collection<String> typesOfInvestments, Collection<String> items, Collection<Integer> years) Fetch all financial accounts years data which match the input constraints.
List<ResponseModel>	getPrimaryIncome() Fetch all primary income data.
List<ResponseModel>	getPrimaryIncome(Collection<String> exportsAndImports, Collection<String> items, Collection<String> quarters) Fetch all primary income data which match the input constraints.
List<ResponseModel>	getRevisions() Fetch all revisions data.
List<ResponseModel>	getRevisions(Collection<String> items, Collection<String> quarters) Fetch all revisions data which match the input constraints.
List<ResponseModel>	getSeasonallyAdjustedCurrentAccountAndCapitalAccount() Fetch all seasonally adjusted current account and capital account data.
List<ResponseModel>	getSeasonallyAdjustedCurrentAccountAndCapitalAccount(Collection<String> items, Collection<String> quarters) Fetch all seasonally adjusted current account and capital account data which match the input constraints.
List<ResponseModel>	getSecondaryIncomeAndCapitalAccounts() Fetch all secondary income and capital accounts data.
List<ResponseModel>	getSecondaryIncomeAndCapitalAccounts(Collection<String> transactions, Collection<String> items, Collection<String> quarters) Fetch all secondary income and capital accounts data which match the input constraints.
List<ResponseModel>	getTransactionsQuarters() Fetch all transactions quarters data.
List<ResponseModel>	getTransactionsQuarters(Collection<String> items, Collection<String> quarters) Fetch all transactions quarters data which match the input constraints.
List<ResponseModel>	getTransactionsYears() Fetch all transactions years data.
List<ResponseModel>	getTransactionsYears(Collection<String> items, Collection<Integer> years) Fetch all transactions years 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

FinancialMarketsBalanceOfPaymentsPaymentsClient

public FinancialMarketsBalanceOfPaymentsPaymentsClient()

Default constructor.

FinancialMarketsBalanceOfPaymentsPaymentsClient

public FinancialMarketsBalanceOfPaymentsPaymentsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getTransactionsQuarters

public List<ResponseModel> getTransactionsQuarters()

Fetch all transactions quarters data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getTransactionsQuarters(Collection, Collection)

getTransactionsQuarters

public List<ResponseModel> getTransactionsQuarters(Collection<String> items,
                                                   Collection<String> quarters)

Fetch all transactions quarters data which match the input constraints.

Parameters:

items - the items

quarters - the quarters

Returns:

the data wrapped in a list of ResponseModel objects

getSeasonallyAdjustedCurrentAccountAndCapitalAccount

public List<ResponseModel> getSeasonallyAdjustedCurrentAccountAndCapitalAccount()

Fetch all seasonally adjusted current account and capital account data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getSeasonallyAdjustedCurrentAccountAndCapitalAccount(Collection, Collection)

getSeasonallyAdjustedCurrentAccountAndCapitalAccount

public List<ResponseModel> getSeasonallyAdjustedCurrentAccountAndCapitalAccount(Collection<String> items,
                                                                                Collection<String> quarters)

Fetch all seasonally adjusted current account and capital account data which match the input constraints.

Parameters:

items - the items

quarters - the quarters

Returns:

the data wrapped in a list of ResponseModel objects

getCurrentAccountsQuarters

public List<ResponseModel> getCurrentAccountsQuarters()

Fetch all current accounts quarters data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getCurrentAccountsQuarters(Collection, Collection, Collection, Collection)

getCurrentAccountsQuarters

public List<ResponseModel> getCurrentAccountsQuarters(Collection<String> countryGroups,
                                                      Collection<String> exportsAndImports,
                                                      Collection<String> items,
                                                      Collection<String> quarters)

Fetch all current accounts quarters data which match the input constraints.

Parameters:

countryGroups - the country groups

exportsAndImports - the exports and imports

items - the items

quarters - the quarters

Returns:

the data wrapped in a list of ResponseModel objects

getFinancialAccountsQuarters

public List<ResponseModel> getFinancialAccountsQuarters()

Fetch all financial accounts quarters data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getFinancialAccountsQuarters(Collection, Collection, Collection)

getFinancialAccountsQuarters

public List<ResponseModel> getFinancialAccountsQuarters(Collection<String> typesOfInvestments,
                                                        Collection<String> items,
                                                        Collection<String> quarters)

Fetch all financial accounts quarters data which match the input constraints.

Parameters:

typesOfInvestments - the types of investments

items - the items

quarters - the quarters

Returns:

the data wrapped in a list of ResponseModel objects

getSecondaryIncomeAndCapitalAccounts

public List<ResponseModel> getSecondaryIncomeAndCapitalAccounts()

Fetch all secondary income and capital accounts data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getSecondaryIncomeAndCapitalAccounts(Collection, Collection, Collection)

getSecondaryIncomeAndCapitalAccounts

public List<ResponseModel> getSecondaryIncomeAndCapitalAccounts(Collection<String> transactions,
                                                                Collection<String> items,
                                                                Collection<String> quarters)

Fetch all secondary income and capital accounts data which match the input constraints.

Parameters:

transactions - the transactions

items - the items

quarters - the quarters

Returns:

the data wrapped in a list of ResponseModel objects

getTransactionsYears

public List<ResponseModel> getTransactionsYears()

Fetch all transactions years data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getTransactionsYears(Collection, Collection)

getTransactionsYears

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

Fetch all transactions years data which match the input constraints.

Parameters:

items - the items

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getRevisions

public List<ResponseModel> getRevisions()

Fetch all revisions data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getRevisions(Collection, Collection)

getRevisions

public List<ResponseModel> getRevisions(Collection<String> items,
                                        Collection<String> quarters)

Fetch all revisions data which match the input constraints.

Parameters:

items - the items

quarters - the quarters

Returns:

the data wrapped in a list of ResponseModel objects

getCurrentAccountsYears

public List<ResponseModel> getCurrentAccountsYears()

Fetch all current accounts years data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getCurrentAccountsYears(Collection, Collection, Collection, Collection)

getCurrentAccountsYears

public List<ResponseModel> getCurrentAccountsYears(Collection<String> countryGroups,
                                                   Collection<String> exportsAndImports,
                                                   Collection<String> items,
                                                   Collection<Integer> years)

Fetch all current accounts years data which match the input constraints.

Parameters:

countryGroups - the country groups

exportsAndImports - the exports and imports

items - the items

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getFinancialAccountsYears

public List<ResponseModel> getFinancialAccountsYears()

Fetch all financial accounts years data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getFinancialAccountsYears(Collection, Collection, Collection)

getFinancialAccountsYears

public List<ResponseModel> getFinancialAccountsYears(Collection<String> typesOfInvestments,
                                                     Collection<String> items,
                                                     Collection<Integer> years)

Fetch all financial accounts years data which match the input constraints.

Parameters:

typesOfInvestments - the types of investments

items - the items

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getPrimaryIncome

public List<ResponseModel> getPrimaryIncome()

Fetch all primary income data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPrimaryIncome(Collection, Collection, Collection)

getPrimaryIncome

public List<ResponseModel> getPrimaryIncome(Collection<String> exportsAndImports,
                                            Collection<String> items,
                                            Collection<String> quarters)

Fetch all primary income data which match the input constraints.

Parameters:

exportsAndImports - the exports and imports

items - the items

quarters - the quarters

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