com.github.dannil.scbjavaclient.client.transport.registeredvehicles.vehicles

Class TransportRegisteredVehiclesVehiclesClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.transport.registeredvehicles.vehicles.TransportRegisteredVehiclesVehiclesClient

public class TransportRegisteredVehiclesVehiclesClient
extends AbstractClient

Client which handles transport registered vehicles vehicles data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getNewRegistrationsOfPassengerCars() Fetch all new registrations of passenger cars data.
List<ResponseModel>	getNewRegistrationsOfPassengerCars(Collection<String> regions, Collection<Integer> fuels, Collection<String> months) Fetch all new registrations of passenger cars data which match the input constraints.
List<ResponseModel>	getPassengerCarsInUse() Fetch all passenger cars in use data.
List<ResponseModel>	getPassengerCarsInUse(Collection<String> regions, Collection<String> typesOfOwnerships, Collection<Integer> years) Fetch all passenger cars in use data which match the input constraints.
URLEndpoint	getUrl() Returns the URL endpoint which this client represents.
List<ResponseModel>	getVehiclesFromTheVehicleRegister() Fetch all vehicles from the vehicle register data.
List<ResponseModel>	getVehiclesFromTheVehicleRegister(Collection<String> typesOfVehicles, Collection<String> statuses, Collection<String> months) Fetch all vehicles from the vehicle register data which match the input constraints.
List<ResponseModel>	getVehiclesInUse() Fetch all vehicles in use data.
List<ResponseModel>	getVehiclesInUse(Collection<String> regions, Collection<Integer> typesOfVehicles, Collection<Integer> years) Fetch all vehicles in use data which match the input constraints.

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

TransportRegisteredVehiclesVehiclesClient

public TransportRegisteredVehiclesVehiclesClient()

Default constructor.

TransportRegisteredVehiclesVehiclesClient

public TransportRegisteredVehiclesVehiclesClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getVehiclesInUse

public List<ResponseModel> getVehiclesInUse()

Fetch all vehicles in use data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getVehiclesInUse(Collection, Collection, Collection)

getVehiclesInUse

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

Fetch all vehicles in use data which match the input constraints.

Parameters:

regions - the regions

typesOfVehicles - the types of vehicles

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getNewRegistrationsOfPassengerCars

public List<ResponseModel> getNewRegistrationsOfPassengerCars()

Fetch all new registrations of passenger cars data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNewRegistrationsOfPassengerCars(Collection, Collection, Collection)

getNewRegistrationsOfPassengerCars

public List<ResponseModel> getNewRegistrationsOfPassengerCars(Collection<String> regions,
                                                              Collection<Integer> fuels,
                                                              Collection<String> months)

Fetch all new registrations of passenger cars data which match the input constraints.

Parameters:

regions - the regions

fuels - the fuels

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getVehiclesFromTheVehicleRegister

public List<ResponseModel> getVehiclesFromTheVehicleRegister()

Fetch all vehicles from the vehicle register data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getVehiclesFromTheVehicleRegister(Collection, Collection,Collection)

getVehiclesFromTheVehicleRegister

public List<ResponseModel> getVehiclesFromTheVehicleRegister(Collection<String> typesOfVehicles,
                                                             Collection<String> statuses,
                                                             Collection<String> months)

Fetch all vehicles from the vehicle register data which match the input constraints.

Parameters:

typesOfVehicles - the types of vehicles

statuses - the statuses

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getPassengerCarsInUse

public List<ResponseModel> getPassengerCarsInUse()

Fetch all passenger cars in use data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPassengerCarsInUse(Collection, Collection, Collection)

getPassengerCarsInUse

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

Fetch all passenger cars in use data which match the input constraints.

Parameters:

regions - the regions

typesOfOwnerships - the types of ownerships

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