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

Class BusinessActivitiesAccomodationStatisticsMonthClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.businessactivities.accomodationstatistics.month.BusinessActivitiesAccomodationStatisticsMonthClient

public class BusinessActivitiesAccomodationStatisticsMonthClient
extends AbstractClient

Client which handles business activities accomodation statistics month data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getAvailableBeds() Fetch all available beds data.
List<ResponseModel>	getAvailableBeds(Collection<String> regions, Collection<String> months) Fetch all available beds data which match the input constraints.
List<ResponseModel>	getNightsSpent() Fetch all nights spent data.
List<ResponseModel>	getNightsSpent(Collection<String> regions, Collection<String> typesOfEstablishments, Collection<String> months) Fetch all nights spent data which match the input constraints.
List<ResponseModel>	getNumberOfAvailableRooms() Fetch all number of available rooms data.
List<ResponseModel>	getNumberOfAvailableRooms(Collection<String> regions, Collection<String> months) Fetch all number of available rooms data which match the input constraints.
List<ResponseModel>	getOccupancy() Fetch all occupancy data.
List<ResponseModel>	getOccupancy(Collection<String> typesOfHousing, Collection<String> months) Fetch all occupancy data which match the input constraints.
List<ResponseModel>	getOccupiedRooms() Fetch all occupied rooms data.
List<ResponseModel>	getOccupiedRooms(Collection<String> regions, Collection<String> months) Fetch all occupied rooms data which match the input constraints.
List<ResponseModel>	getRevenueOfOccupiedRooms() Fetch all revenue of occupied rooms data.
List<ResponseModel>	getRevenueOfOccupiedRooms(Collection<String> months) Fetch all revenue of occupied rooms data which match the input constraints.
List<ResponseModel>	getTotalCapacity() Fetch all total capacity data.
List<ResponseModel>	getTotalCapacity(Collection<String> typesOfEstablishments, Collection<String> months) Fetch all total capacity 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, getLocale, getLocalizationLocale, getResponseModels, getResponseModels, getRootUrl, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessActivitiesAccomodationStatisticsMonthClient

public BusinessActivitiesAccomodationStatisticsMonthClient()

Default constructor.

BusinessActivitiesAccomodationStatisticsMonthClient

public BusinessActivitiesAccomodationStatisticsMonthClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getTotalCapacity

public List<ResponseModel> getTotalCapacity()

Fetch all total capacity data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getTotalCapacity(Collection, Collection)

getTotalCapacity

public List<ResponseModel> getTotalCapacity(Collection<String> typesOfEstablishments,
                                            Collection<String> months)

Fetch all total capacity data which match the input constraints.

Parameters:

typesOfEstablishments - the types of establishments

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getAvailableBeds

public List<ResponseModel> getAvailableBeds()

Fetch all available beds data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAvailableBeds(Collection, Collection)

getAvailableBeds

public List<ResponseModel> getAvailableBeds(Collection<String> regions,
                                            Collection<String> months)

Fetch all available beds data which match the input constraints.

Parameters:

regions - the regions

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getNumberOfAvailableRooms

public List<ResponseModel> getNumberOfAvailableRooms()

Fetch all number of available rooms data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNumberOfAvailableRooms(Collection, Collection)

getNumberOfAvailableRooms

public List<ResponseModel> getNumberOfAvailableRooms(Collection<String> regions,
                                                     Collection<String> months)

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

Parameters:

regions - the regions

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getNightsSpent

public List<ResponseModel> getNightsSpent()

Fetch all nights spent data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNightsSpent(Collection, Collection, Collection)

getNightsSpent

public List<ResponseModel> getNightsSpent(Collection<String> regions,
                                          Collection<String> typesOfEstablishments,
                                          Collection<String> months)

Fetch all nights spent data which match the input constraints.

Parameters:

regions - the regions

typesOfEstablishments - the types of establishments

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getOccupancy

public List<ResponseModel> getOccupancy()

Fetch all occupancy data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getOccupancy(Collection, Collection)

getOccupancy

public List<ResponseModel> getOccupancy(Collection<String> typesOfHousing,
                                        Collection<String> months)

Fetch all occupancy data which match the input constraints.

Parameters:

typesOfHousing - the types of housing

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getOccupiedRooms

public List<ResponseModel> getOccupiedRooms()

Fetch all occupied rooms data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getOccupiedRooms(Collection, Collection)

getOccupiedRooms

public List<ResponseModel> getOccupiedRooms(Collection<String> regions,
                                            Collection<String> months)

Fetch all occupied rooms data which match the input constraints.

Parameters:

regions - the regions

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getRevenueOfOccupiedRooms

public List<ResponseModel> getRevenueOfOccupiedRooms()

Fetch all revenue of occupied rooms data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getRevenueOfOccupiedRooms(Collection)

getRevenueOfOccupiedRooms

public List<ResponseModel> getRevenueOfOccupiedRooms(Collection<String> months)

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

Parameters:

months - the months

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