com.github.dannil.scbjavaclient.client.businessactivities.accomodationstatistics.year

Class BusinessActivitiesAccomodationStatisticsYearClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.businessactivities.accomodationstatistics.year.BusinessActivitiesAccomodationStatisticsYearClient

public class BusinessActivitiesAccomodationStatisticsYearClient
extends AbstractClient

Client which handles business activities accomodation statistics year data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getAccomodationRevenue() Fetch all accomodation revenue data.
List<ResponseModel>	getAccomodationRevenue(Collection<String> regions, Collection<Integer> years) Fetch all accomodation revenue data which match the input constraints.
List<ResponseModel>	getCapacityForHotels() Fetch all capacity for hotels data.
List<ResponseModel>	getCapacityForHotels(Collection<String> regions, Collection<String> typesOfHousing, Collection<Integer> years) Fetch all capacity for hotels data which match the input constraints.
List<ResponseModel>	getNumberOfHotels() Fetch all number of hotels data.
List<ResponseModel>	getNumberOfHotels(Collection<String> regions, Collection<String> typesOfEstablishments, Collection<Integer> years) Fetch all number of hotels data which match the input constraints.
List<ResponseModel>	getNumberOfOccupiedRooms() Fetch all number of occupied rooms data.
List<ResponseModel>	getNumberOfOccupiedRooms(Collection<String> regions, Collection<Integer> years) Fetch all number of occupied rooms data which match the input constraints.
List<ResponseModel>	getOccupancyRate() Fetch all occupancy rate data.
List<ResponseModel>	getOccupancyRate(Collection<String> regions, Collection<String> typesOfHousing, Collection<Integer> years) Fetch all occupancy rate 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

BusinessActivitiesAccomodationStatisticsYearClient

public BusinessActivitiesAccomodationStatisticsYearClient()

Default constructor.

BusinessActivitiesAccomodationStatisticsYearClient

public BusinessActivitiesAccomodationStatisticsYearClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getNumberOfHotels

public List<ResponseModel> getNumberOfHotels()

Fetch all number of hotels data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNumberOfHotels(Collection, Collection, Collection)

getNumberOfHotels

public List<ResponseModel> getNumberOfHotels(Collection<String> regions,
                                             Collection<String> typesOfEstablishments,
                                             Collection<Integer> years)

Fetch all number of hotels data which match the input constraints.

Parameters:

regions - the regions

typesOfEstablishments - the types of establishments

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getCapacityForHotels

public List<ResponseModel> getCapacityForHotels()

Fetch all capacity for hotels data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getCapacityForHotels(Collection, Collection, Collection)

getCapacityForHotels

public List<ResponseModel> getCapacityForHotels(Collection<String> regions,
                                                Collection<String> typesOfHousing,
                                                Collection<Integer> years)

Fetch all capacity for hotels data which match the input constraints.

Parameters:

regions - the regions

typesOfHousing - the types of housing

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getOccupancyRate

public List<ResponseModel> getOccupancyRate()

Fetch all occupancy rate data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getOccupancyRate(Collection, Collection, Collection)

getOccupancyRate

public List<ResponseModel> getOccupancyRate(Collection<String> regions,
                                            Collection<String> typesOfHousing,
                                            Collection<Integer> years)

Fetch all occupancy rate data which match the input constraints.

Parameters:

regions - the regions

typesOfHousing - the types of housing

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getNumberOfOccupiedRooms

public List<ResponseModel> getNumberOfOccupiedRooms()

Fetch all number of occupied rooms data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNumberOfOccupiedRooms(Collection, Collection)

getNumberOfOccupiedRooms

public List<ResponseModel> getNumberOfOccupiedRooms(Collection<String> regions,
                                                    Collection<Integer> years)

Fetch all number of occupied rooms data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getAccomodationRevenue

public List<ResponseModel> getAccomodationRevenue()

Fetch all accomodation revenue data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAccomodationRevenue(Collection, Collection)

getAccomodationRevenue

public List<ResponseModel> getAccomodationRevenue(Collection<String> regions,
                                                  Collection<Integer> years)

Fetch all accomodation revenue data which match the input constraints.

Parameters:

regions - the regions

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